LOGO

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

Detailed Description

Base class for all RestFrame package objects.

Abstract base class from which all RestFrame package objects inherit.

Definition at line 53 of file RFBase.hh.

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

Public Member Functions

 RFBase (const std::string &sname, const std::string &stitle, int key)
 Standard constructor. More...
 
 RFBase ()
 Empty constructor.
 
virtual void Clear ()
 Clears RFBase of all connections to other objects.
 
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.
 
RFBase identity/comparison methods

RFBase identity query member functions

Member functions for identifying/comparing class instances

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 RFBaseEmpty ()
 Returns empty RFBase. More...
 

Protected Member Functions

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
 

Protected Attributes

RFLog m_Log
 
RFBasem_This
 

Static Protected Attributes

static const TVector3 m_Empty3Vector
 
static const TLorentzVector m_Empty4Vector
 

Friends

void SetWarningTolerance (int NMAX)
 Sets the tolerance for the number of RestFrames warnings. More...
 

Constructor & Destructor Documentation

◆ RFBase()

RestFrames::RFBase::RFBase ( const std::string &  sname,
const std::string &  stitle,
int  key 
)

Standard constructor.

Parameters
snameClass instance name used for log statements
stitleClass instance title used in figures
keyUnique id of frame

Definition at line 54 of file RFBase.cc.

Member Function Documentation

◆ Empty()

RFBase & RestFrames::RFBase::Empty ( )
static

Returns empty RFBase.

Returns
Empty RFBase

Definition at line 80 of file RFBase.cc.

Friends And Related Function Documentation

◆ SetWarningTolerance

void SetWarningTolerance ( int  NMAX = -1)
friend

Sets the tolerance for the number of RestFrames warnings.

Parameters
NMAXNumber of allowed warnings of a given type

Method sets the tolerance for the number of RestFranes warnings. NMAX less than 1 indicate infinite tolerance.

Parameters
NMAXNumber of allowed warnings of a given type

Function sets the tolerance for the number of RestFrames warnings. Numbers less than 1 indicate infinite tolerance.

Definition at line 223 of file RFBase.cc.

#include <RFBase.hh>

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

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