LOGO

RestFrames  v1.0.1
RestFrames HEP Event Analysis Software Library
Public Member Functions | Protected Member Functions | List of all members
RestFrames::LabFrame< T > Class Template Referenceabstract

Detailed Description

template<class T>
class RestFrames::LabFrame< T >

Definition at line 41 of file LabFrame.hh.

Inheritance diagram for RestFrames::LabFrame< T >:
Inheritance graph
[legend]

Public Member Functions

 LabFrame (const std::string &sname, const std::string &stitle)
 Standard constructor. More...
 
 LabFrame ()
 Empty constructor.
 
void SetChildFrame (RestFrame &frame)
 Sets child of this frame. More...
 
virtual bool InitializeTree ()
 Method to initialize tree. More...
 
virtual bool InitializeAnalysis ()=0
 Virtual method for intialzing analysis capabilities of a tree corresponding to a LabFrame. More...
 
virtual bool ClearEvent ()=0
 Virtual method to clear event. More...
 
virtual bool AnalyzeEvent ()=0
 Virtual method to analyze event. More...
 
TVector3 GetInvisibleMomentum () const
 Returns invisible momentum vector of this RestFrame. More...
 

Protected Member Functions

virtual bool IsSoundBody () const
 

Constructor & Destructor Documentation

◆ LabFrame()

template<class T >
RestFrames::LabFrame< T >::LabFrame ( 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 40 of file LabFrame.cc.

Member Function Documentation

◆ AnalyzeEvent()

template<class T >
virtual bool RestFrames::LabFrame< T >::AnalyzeEvent ( )
pure virtual

Virtual method to analyze event.

Returns
True if method was successful else false
Warning
AnalyzeEvent() can only be called after successful call to InitalizeAnalysis()

Implemented in RestFrames::LabRecoFrame, and RestFrames::LabGenFrame.

◆ ClearEvent()

template<class T >
virtual bool RestFrames::LabFrame< T >::ClearEvent ( )
pure virtual

Virtual method to clear event.

Returns
True if method was successful else false
Warning
ClearEvent() can only be called after successful call to InitalizeAnalysis()

Implemented in RestFrames::LabRecoFrame, and RestFrames::LabGenFrame.

◆ GetInvisibleMomentum()

template<class T >
TVector3 RestFrames::LabFrame< T >::GetInvisibleMomentum

Returns invisible momentum vector of this RestFrame.

Returns
Invisible momentum vector of this RestFrame

Definition at line 109 of file LabFrame.cc.

◆ InitializeAnalysis()

template<class T >
virtual bool RestFrames::LabFrame< T >::InitializeAnalysis ( )
pure virtual

Virtual method for intialzing analysis capabilities of a tree corresponding to a LabFrame.

Returns
True if method was successful else False
Warning
InitializeAnalysis() can only be called after successful call to InitializeTree()

Implemented in RestFrames::LabRecoFrame, and RestFrames::LabGenFrame.

◆ InitializeTree()

template<class T >
bool RestFrames::LabFrame< T >::InitializeTree
virtual

Method to initialize tree.

Returns
True if method was successful else False

Definition at line 81 of file LabFrame.cc.

◆ SetChildFrame()

template<class T >
void RestFrames::LabFrame< T >::SetChildFrame ( RestFrame frame)

Sets child of this frame.

Parameters
frameFrame to be set as child

Definition at line 76 of file LabFrame.cc.

Collaboration diagram for RestFrames::LabFrame< T >:
Collaboration graph
[legend]

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