LOGO

RestFrames  v1.0.1
RestFrames HEP Event Analysis Software Library
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
RestFrames::VisibleState Class Reference

Detailed Description

Definition at line 39 of file VisibleState.hh.

Inheritance diagram for RestFrames::VisibleState:
Inheritance graph
[legend]

Public Member Functions

 VisibleState (const std::string &sname, const std::string &stitle)
 Standard constructor. More...
 
 VisibleState ()
 Empty constructor.
 
virtual void Clear ()
 Clears Visible State to all connections to other objects.
 
virtual void AddFrame (const RestFrame &frame)
 Adds a frame (RestFrame) to this state. More...
 
virtual RestFrame const & GetFrame () const
 Returns frame (RestFrame) of this state. More...
 
virtual bool IsFrame (const RestFrame &frame) const
 Checks if frame of state corresponds to frame More...
 
virtual bool IsFrames (const ConstRestFrameList &frames) const
 Checks if frames lists of state corresponds frames More...
 
virtual void SetLabFrameFourVector ()
 Sets four-vector of lab frame.
 
virtual void SetCharge (const RFCharge &charge)
 Sets charge of this state. More...
 
virtual void SetCharge (int charge=0)
 Sets charge of this state. More...
 
virtual void SetCharge (int charge_num, int charge_den)
 Sets charge of this state. More...
 
- Public Member Functions inherited from RestFrames::State
 State (const std::string &sname, const std::string &stitle)
 Standard constructor. More...
 
 State ()
 Empty constructor.
 
StateType GetType () const
 Returns State (StateType) type. More...
 
bool IsVisibleState () const
 Is this a VisibleState? (true/false) More...
 
bool IsInvisibleState () const
 Is this an InvisibleState? (true/false) More...
 
bool IsCombinatoricState () const
 Is this a CombinatoricState? (true/false) More...
 
virtual void AddFrames (const ConstRestFrameList &frames)
 Adds a list of frames (RestFrame) to this state. More...
 
ConstRestFrameList const & GetListFrames () const
 Returns list of frames (RestFrame) contained in this state. More...
 
int GetNFrames () const
 Returns number of frames (RestFrame) contained in this state. More...
 
virtual void SetParentJigsaw (Jigsaw &jigsaw=Jigsaw::Empty())
 Sets the parent jigsaw (Jigsaw) to jigsaw More...
 
virtual void SetChildJigsaw (Jigsaw &jigsaw=Jigsaw::Empty())
 Sets the child jigsaw (Jigsaw) to jigsaw More...
 
virtual JigsawGetParentJigsaw () const
 Returns the parent of this jigsaw (Jigsaw) More...
 
virtual JigsawGetChildJigsaw () const
 Returns the child of this jigsaw (Jigsaw) More...
 
virtual void Boost (const TVector3 &B)
 Boosts to different frame (RestFrame) More...
 
virtual void SetFourVector (const TLorentzVector &V)
 Sets four-vector of this frame. More...
 
virtual TLorentzVector GetFourVector () const
 Returns four vector of this frame. More...
 
virtual RFCharge GetCharge () const
 Returns charge of this frames. More...
 
- Public Member Functions inherited from RestFrames::RFBase
 RFBase (const std::string &sname, const std::string &stitle, int key)
 Standard constructor. More...
 
 RFBase ()
 Empty constructor.
 
bool IsEmpty () const
 Checks whether this is default (empty) instance of class.
 
bool operator! () const
 Tests whether key is the same as this.
 
void Print (LogType type) const
 Print information associated with object.
 
virtual std::string PrintString (LogType type) const
 String of information associated with object.
 
RFKey GetKey () const
 gets object identification key
 
std::string GetName () const
 Returns object name.
 
std::string GetTitle () const
 Returns object title.
 
bool IsSame (const RFKey &key) const
 Tests whether key is the same as this.
 
bool IsSame (const RFBase &obj) const
 Tests whether obj is the same as this.
 
bool operator== (const RFKey &key) const
 Tests whether key is the same as this.
 
bool operator== (const RFBase &obj) const
 Tests whether obj is the same as this.
 
bool operator!= (const RFKey &key) const
 Tests whether key is the same as this.
 
bool operator!= (const RFBase &obj) const
 Tests whether obj is the same as this.
 

Static Public Member Functions

static VisibleStateEmpty ()
 Returns empty VisibleState. More...
 
- Static Public Member Functions inherited from RestFrames::State
static StateEmpty ()
 Returns empty state. More...
 
static StateList const & EmptyList ()
 Returns empty StateList. More...
 
- Static Public Member Functions inherited from RestFrames::RFBase
static RFBaseEmpty ()
 Returns empty RFBase. More...
 

Protected Attributes

const VisibleRecoFramem_FramePtr
 
- Protected Attributes inherited from RestFrames::State
StateType m_Type
 
RFCharge m_Charge
 
ConstRestFrameList m_Frames
 
- Protected Attributes inherited from RestFrames::RFBase
RFLog m_Log
 
RFBasem_This
 

Additional Inherited Members

- Protected Member Functions inherited from RestFrames::RFBase
bool SetBody (bool body) const
 
bool SetMind (bool mind) const
 
bool SetSpirit (bool spirit) const
 
virtual bool IsSoundBody () const
 
virtual bool IsSoundMind () const
 
virtual bool IsSoundSpirit () const
 
void UnSoundBody (const std::string &function) const
 
void UnSoundMind (const std::string &function) const
 
void UnSoundSpirit (const std::string &function) const
 
void AddDependent (RFBase *dep)
 pointer to RFBase object owned by this one
 
- Static Protected Attributes inherited from RestFrames::RFBase
static const TVector3 m_Empty3Vector
 
static const TLorentzVector m_Empty4Vector
 

Constructor & Destructor Documentation

◆ VisibleState()

RestFrames::VisibleState::VisibleState ( const std::string &  sname,
const std::string &  stitle 
)

Standard constructor.

Parameters
snameClass instance name used for log statements
stitleClass instance title used in figures

Definition at line 36 of file VisibleState.cc.

Member Function Documentation

◆ AddFrame()

void RestFrames::VisibleState::AddFrame ( const RestFrame frame)
virtual

Adds a frame (RestFrame) to this state.

Parameters
frameFrame to be added
Warning
frame must be a VisibleFrame and ReconstructionFrame type frame, if it isn't frame won't be added to state

Implements RestFrames::State.

Definition at line 57 of file VisibleState.cc.

◆ Empty()

VisibleState & RestFrames::VisibleState::Empty ( )
static

Returns empty VisibleState.

Returns
Empty VisibleState

Definition at line 53 of file VisibleState.cc.

◆ GetFrame()

RestFrame const & RestFrames::VisibleState::GetFrame ( ) const
virtual

Returns frame (RestFrame) of this state.

Returns
Frame of this state

Definition at line 77 of file VisibleState.cc.

◆ IsFrame()

bool RestFrames::VisibleState::IsFrame ( const RestFrame frame) const
virtual

Checks if frame of state corresponds to frame

Parameters
frameFrame to check
Returns
True if frame of state corresponds to frame matches frame else False

Reimplemented from RestFrames::State.

Definition at line 67 of file VisibleState.cc.

◆ IsFrames()

bool RestFrames::VisibleState::IsFrames ( const ConstRestFrameList frames) const
virtual

Checks if frames lists of state corresponds frames

Parameters
framesFrames to check
Returns
True if lists are the same else False

Reimplemented from RestFrames::State.

Definition at line 73 of file VisibleState.cc.

◆ SetCharge() [1/3]

void RestFrames::VisibleState::SetCharge ( const RFCharge charge)
virtual

Sets charge of this state.

Parameters
chargeCharge to be set

Definition at line 90 of file VisibleState.cc.

◆ SetCharge() [2/3]

void RestFrames::VisibleState::SetCharge ( int  charge = 0)
virtual

Sets charge of this state.

Parameters
chargeCharge to be set

Definition at line 94 of file VisibleState.cc.

◆ SetCharge() [3/3]

void RestFrames::VisibleState::SetCharge ( int  charge_num,
int  charge_den 
)
virtual

Sets charge of this state.

Parameters
charge_numNumerator
charge_denDenominator

Definition at line 98 of file VisibleState.cc.

Collaboration diagram for RestFrames::VisibleState:
Collaboration graph
[legend]

The documentation for this class was generated from the following files: