Detailed Description

Definition at line 43 of file CombinatoricState.hh.

Inheritance diagram for RestFrames::CombinatoricState:

Public Member Functions
	CombinatoricState (const std::string &sname, const std::string &stitle)
	Standard constructor. More...

	CombinatoricState ()
	Empty constructor.

virtual void	Clear ()
	Clears CombinatoricState of all connections to other objects.

virtual void	AddFrame (const RestFrame &frame)
	Adds a frame (RestFrame) to this state. More...

virtual void	SetParentJigsaw (Jigsaw &jigsaw)
	Sets the parent jigsaw (Jigsaw) to jigsaw More...

virtual void	SetChildJigsaw (Jigsaw &jigsaw)
	Sets the child jigsaw (Jigsaw) to jigsaw More...

virtual void	Boost (const TVector3 &B)
	Boosts to different frame (RestFrame) More...

virtual TLorentzVector	GetFourVector () const
	Returns four-vector of current frame. More...

virtual RFCharge	GetCharge () const
	Returns charge of current frame. More...

Methods that imply elements
Note that elements are just visible states. The notation "elements" is used since these visible states correspond to the elements of a set
void	ClearElements ()
	Clears all elements associated with this state.

void	AddElement (VisibleState &state)
	Adds element to this state. More...

void	AddElements (const VisibleStateList &states)
	Adds elements to this state. More...

VisibleStateList const &	GetElements () const
	Returns elements of this state. More...

int	GetNElements () const
	Returns number of elements in this state. More...

bool	ContainsElement (const State &state) const
	Is state element contained in this state (true/false)

bool	ContainsElement (const RFKey &key) const
	Is element with key contained in this state (true/false)

VisibleState const &	GetElement (const RFKey &key) const
	Returns element with key in 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 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 Jigsaw &	GetParentJigsaw () const
	Returns the parent of this jigsaw (Jigsaw) More...

virtual Jigsaw &	GetChildJigsaw () const
	Returns the child of this jigsaw (Jigsaw) More...

virtual void	SetFourVector (const TLorentzVector &V)
	Sets four-vector of this frame. 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 CombinatoricState &	Empty ()
	Returns empty CombinatoricState. More...

Static Public Member Functions inherited from RestFrames::State
static State &	Empty ()
	Returns empty state. More...

static StateList const &	EmptyList ()
	Returns empty StateList. More...

Static Public Member Functions inherited from RestFrames::RFBase
static RFBase &	Empty ()
	Returns empty RFBase. More...

Protected Attributes
VisibleStateList	m_Elements

Protected Attributes inherited from RestFrames::State
StateType	m_Type

RFCharge	m_Charge

ConstRestFrameList	m_Frames

Protected Attributes inherited from RestFrames::RFBase
RFLog	m_Log

RFBase *	m_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

◆ CombinatoricState()

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

Standard constructor.

Parameters

sname	Class instance name used for log statements
stitle	Class instance title used in figures

Definition at line 41 of file CombinatoricState.cc.

Member Function Documentation

◆ AddElement()

void RestFrames::CombinatoricState::AddElement ( VisibleState & state )

Adds element to this state.

Parameters

state Element to be added

Definition at line 87 of file CombinatoricState.cc.

◆ AddElements()

void RestFrames::CombinatoricState::AddElements ( const VisibleStateList & states )

Adds elements to this state.

Parameters

states List of elements to be added

Definition at line 92 of file CombinatoricState.cc.

◆ AddFrame()

void RestFrames::CombinatoricState::AddFrame ( const RestFrame & frame )

virtual

Adds a frame (RestFrame) to this state.

Parameters

frame Frame 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 61 of file CombinatoricState.cc.

◆ Boost()

void RestFrames::CombinatoricState::Boost ( const TVector3 & B )

virtual

Boosts to different frame (RestFrame)

Parameters

B	Boost factor (units: speed of light)

Method for boosting to a different reference frame

Reimplemented from RestFrames::State.

Definition at line 117 of file CombinatoricState.cc.

◆ Empty()

CombinatoricState & RestFrames::CombinatoricState::Empty ( )

static

Returns empty CombinatoricState.

Returns: Empty CombinatoricState

Definition at line 52 of file CombinatoricState.cc.

◆ GetCharge()

RFCharge RestFrames::CombinatoricState::GetCharge ( ) const

virtual

Returns charge of current frame.

Returns: Charge of current frame

Reimplemented from RestFrames::State.

Definition at line 126 of file CombinatoricState.cc.

◆ GetElement()

VisibleState const & RestFrames::CombinatoricState::GetElement ( const RFKey & key ) const

Returns element with key in this state.

Parameters

key	Unique ID of element

Returns: Element with key in this state

Definition at line 113 of file CombinatoricState.cc.

◆ GetElements()

VisibleStateList const & RestFrames::CombinatoricState::GetElements ( ) const

Returns elements of this state.

Returns: Elements of this state

Definition at line 97 of file CombinatoricState.cc.

◆ GetFourVector()

TLorentzVector RestFrames::CombinatoricState::GetFourVector ( ) const

virtual

Returns four-vector of current frame.

Returns: Four-vector of current frame

Reimplemented from RestFrames::State.

Definition at line 122 of file CombinatoricState.cc.

◆ GetNElements()

int RestFrames::CombinatoricState::GetNElements ( ) const

Returns number of elements in this state.

Returns: Number of elements in this state

Definition at line 101 of file CombinatoricState.cc.

◆ SetChildJigsaw()

void RestFrames::CombinatoricState::SetChildJigsaw ( Jigsaw & jigsaw )

virtual

Sets the child jigsaw (Jigsaw) to jigsaw

Parameters

jisaw Jigsaw to be set as child

Method for connecting a parent jigsaw to its child jigsaw. Calls State::SetChildJigsaw()

Warning: jigsaw must be a CombinatoricJigsaw type jigsaw, if it isn't jigsaw won't be added to this state

Reimplemented from RestFrames::State.

Definition at line 77 of file CombinatoricState.cc.

◆ SetParentJigsaw()

void RestFrames::CombinatoricState::SetParentJigsaw ( Jigsaw & jigsaw )

virtual

Sets the parent jigsaw (Jigsaw) to jigsaw

Parameters

jisaw Jigsaw to be set as parent

Method for connecting a child jigsaw to its parent jigsaw. Calls State::SetParentJigsaw()

Warning: jigsaw must be a CombinatoricJigsaw type jigsaw, if it isn't jigsaw won't be added to this state

Reimplemented from RestFrames::State.

Definition at line 71 of file CombinatoricState.cc.

Collaboration diagram for RestFrames::CombinatoricState:

[legend]

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

inc/RestFrames/CombinatoricState.hh
src/CombinatoricState.cc

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ CombinatoricState()

Member Function Documentation

◆ AddElement()

◆ AddElements()

◆ AddFrame()

◆ Boost()

◆ Empty()

◆ GetCharge()

◆ GetElement()

◆ GetElements()

◆ GetFourVector()

◆ GetNElements()

◆ SetChildJigsaw()

◆ SetParentJigsaw()