SFrame 3.6
SCycleBaseBase Class Reference

Absolute base of all analysis cycles. More...

#include <core/include/SCycleBaseBase.h>

Inheritance diagram for SCycleBaseBase:
Collaboration diagram for SCycleBaseBase:

List of all members.

Public Member Functions

 SCycleBaseBase ()
 Default constructor.
virtual ~SCycleBaseBase ()
 Default destructor.

Protected Member Functions

void SetLogName (const char *name)
 Function used to set the name of the current cycle.
SLoggerlogger () const
 Function for accessing the logger object.

Protected Attributes

SLogger m_logger
 Object used for output messages to the terminal.

Detailed Description

Absolute base of all analysis cycles.

Absolute base object in the SCycleBase hierarchy. All "parts" of SCycleBase have to inherit from this with "public virtual", so that it only gets created once in memory for each cycle...

Version:
Revision:
231

Definition at line 32 of file SCycleBaseBase.h.


Constructor & Destructor Documentation

SCycleBaseBase::SCycleBaseBase ( )

Default constructor.

The constructor is not doing much. It just initialises the m_logger member.

Definition at line 24 of file SCycleBaseBase.cxx.

References REPORT_VERBOSE.

virtual SCycleBaseBase::~SCycleBaseBase ( ) [inline, virtual]

Default destructor.

Definition at line 38 of file SCycleBaseBase.h.


Member Function Documentation

SLogger& SCycleBaseBase::logger ( ) const [inline, protected]

Function for accessing the logger object.

Definition at line 44 of file SCycleBaseBase.h.

References m_logger.

void SCycleBaseBase::SetLogName ( const char *  name) [protected]

Function used to set the name of the current cycle.

Since this base class doesn't inherit from TObject anymore, it can't know the name of the user cycle anymore unfortunately. So all user cycles have to put a line like this in their constructor:

SetLogName( this->GetName() );

Parameters:
nameName of the current cycle

Definition at line 41 of file SCycleBaseBase.cxx.

References m_logger, and SLogger::SetSource().

Referenced by SCycleBaseExec::SCycleBaseExec().


Member Data Documentation

SLogger SCycleBaseBase::m_logger [mutable, protected]

Object used for output messages to the terminal.

In the whole SFrame framework, terminal messages are printed using the SLogger class. This makes it possible to print nice formatted messages to the teminal. The user should preferably use this object to write messages instead of using std::cout directly.

Definition at line 54 of file SCycleBaseBase.h.

Referenced by logger(), SCycleBaseExec::Notify(), SCycleBaseExec::Process(), SetLogName(), SCycleBaseExec::SlaveBegin(), SCycleBaseExec::SlaveTerminate(), and SCycleBaseHist::WriteHistObjects().


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