Base class from which all concrete algorithm classes should be derived. More...

#include <GaudiKernel/Algorithm.h>

Inheritance diagram for Algorithm:

Collaboration diagram for Algorithm:

Public Types
typedef Gaudi::PluginService::Factory2 < IAlgorithm , const std::string &, ISvcLocator >	Factory

Public Types inherited from implements3< IAlgorithm, IProperty, IStateful >
typedef implements3	base_class
	Typedef to this class. More...

typedef extend_interfaces3 < IAlgorithm, IProperty, IStateful >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

Public Types inherited from extend_interfaces3< IAlgorithm, IProperty, IStateful >
typedef mpl::fold< typename IAlgorithm::iid::iids::type, typename mpl::fold< typename IProperty::iid::iids::type, typename IStateful::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...

Public Types inherited from IInterface
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...

typedef Gaudi::InterfaceId < IInterface, 0, 0 >	iid
	Interface ID. More...

typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...

Public Member Functions
	Algorithm (const std::string &name, ISvcLocator *svcloc, const std::string &version=PACKAGE_VERSION)
	Constructor. More...

virtual	~Algorithm ()
	Destructor. More...

virtual StatusCode	sysStart ()
	Reinitialization method invoked by the framework. More...

virtual StatusCode	sysInitialize ()
	Initialization method invoked by the framework. More...

virtual StatusCode	sysReinitialize ()
	Reinitialization method invoked by the framework. More...

virtual StatusCode	sysRestart ()
	Restart method invoked by the framework. More...

virtual StatusCode	sysExecute ()
	The actions to be performed by the algorithm on an event. More...

virtual StatusCode	sysStop ()
	System stop. More...

virtual StatusCode	sysFinalize ()
	System finalization. More...

virtual StatusCode	sysBeginRun ()
	beginRun method invoked by the framework. More...

virtual StatusCode	sysEndRun ()
	endRun method invoked by the framework. More...

virtual const std::string &	name () const
	The identifying name of the algorithm object. More...

virtual const std::string &	version () const
	The version of the algorithm. More...

virtual StatusCode	configure ()
	Dummy implementation of IStateful::configure() method. More...

virtual StatusCode	terminate ()
	Dummy implementation of IStateful::terminate() method. More...

virtual StatusCode	initialize ()
	the default (empty) implementation of IStateful::initialize() method More...

virtual StatusCode	start ()
	the default (empty) implementation of IStateful::start() method More...

virtual StatusCode	stop ()
	the default (empty) implementation of IStateful::stop() method More...

virtual StatusCode	finalize ()
	the default (empty) implementation of IStateful::finalize() method More...

virtual StatusCode	reinitialize ()
	the default (empty) implementation of IStateful::reinitialize() method More...

virtual StatusCode	restart ()
	the default (empty) implementation of IStateful::restart() method More...

virtual bool	isExecuted () const
	Has this algorithm been executed since the last reset? More...

virtual void	setExecuted (bool state)
	Set the executed flag to the specified state. More...

virtual void	resetExecuted ()
	Reset the executed state of the Algorithm for the duration of the current event. More...

virtual StatusCode	beginRun ()
	Algorithm begin run. More...

virtual StatusCode	endRun ()
	Algorithm end run. This method is called at the end of the event loop. More...

virtual Gaudi::StateMachine::State	FSMState () const
	returns the current state of the algorithm More...

virtual Gaudi::StateMachine::State	targetFSMState () const
	returns the state the algorithm will be in after the ongoing transition More...

virtual bool	isEnabled () const
	Is this algorithm enabled or disabled? More...

virtual bool	filterPassed () const
	Did this algorithm pass or fail its filter criterion for the last event? More...

virtual void	setFilterPassed (bool state)
	Set the filter passed flag to the specified state. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

SmartIF< IService >	service (const std::string &name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name") More...

void	setOutputLevel (int level)
	Set the output level for current algorithm. More...

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

SmartIF< IChronoStatSvc > &	chronoSvc () const
	The standard Chrono & Stat service, Return a pointer to the service if present. More...

SmartIF< IChronoStatSvc > &	chronoStatService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IDataProviderSvc > &	detSvc () const
	The standard detector data service. More...

SmartIF< IDataProviderSvc > &	detDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IConversionSvc > &	detCnvSvc () const
	The standard detector data persistency conversion service. More...

SmartIF< IConversionSvc > &	detDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IDataProviderSvc > &	eventSvc () const
	The standard event data service. More...

SmartIF< IDataProviderSvc > &	evtSvc () const
	shortcut for method eventSvc More...

SmartIF< IDataProviderSvc > &	eventDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IConversionSvc > &	eventCnvSvc () const
	The standard event data persistency conversion service. More...

SmartIF< IConversionSvc > &	eventDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IHistogramSvc > &	histoSvc () const
	The standard histogram service. More...

SmartIF< IHistogramSvc > &	histogramDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...

SmartIF< IMessageSvc > &	messageService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< INTupleSvc > &	ntupleSvc () const
	The standard N tuple service. More...

SmartIF< INTupleSvc > &	ntupleService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IRndmGenSvc > &	randSvc () const
	AIDA-based NTuple service Returns a pointer to the AIDATuple service if present. More...

SmartIF< IToolSvc > &	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present. More...

SmartIF< IExceptionSvc > &	exceptionSvc () const
	Get the exception Service. More...

SmartIF< IAlgContextSvc > &	contextSvc () const
	get Algorithm Context Service More...

SmartIF< ISvcLocator > &	serviceLocator () const
	The standard service locator. More...

SmartIF< ISvcLocator > &	svcLoc () const
	shortcut for method serviceLocator More...

bool	registerContext () const
	register for Algorithm Context Service? More...

StatusCode	createSubAlgorithm (const std::string &type, const std::string &name, Algorithm *&pSubAlg)
	Create a sub algorithm. More...

std::vector< Algorithm * > *	subAlgorithms () const
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...

virtual StatusCode	setProperty (const Property &p)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	setProperty (const std::string &s)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	getProperty (Property *p) const
	Implementation of IProperty::getProperty. More...

virtual const Property &	getProperty (const std::string &name) const
	Implementation of IProperty::getProperty. More...

virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Implementation of IProperty::getProperty. More...

virtual const std::vector < Property * > &	getProperties () const
	Implementation of IProperty::getProperties. More...

StatusCode	setProperties ()
	Set the algorithm's properties. More...

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

SmartIF< IMonitorSvc > &	monitorSvc () const
	Access the monitor service. More...

template<class T >
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information. More...

void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case) More...

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

Public Member Functions inherited from extend_interfaces3< IAlgorithm, IProperty, IStateful >
virtual	~extend_interfaces3 ()
	Virtual destructor. More...

Public Member Functions inherited from IAlgorithm
	DeclareInterfaceID (IAlgorithm, 4, 0)
	InterfaceID. More...

virtual StatusCode	execute ()=0
	The action to be performed by the algorithm on an event. More...

Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID. More...

virtual	~INamedInterface ()
	Virtual destructor (always needed for abstract classes). More...

Public Member Functions inherited from IInterface
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function More...

virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces. More...

virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...

virtual unsigned long	release ()=0
	Release Interface instance. More...

virtual unsigned long	refCount () const =0
	Current reference count. More...

virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance. More...

virtual	~IInterface ()
	Virtual destructor. More...

Public Member Functions inherited from IProperty
	DeclareInterfaceID (IProperty, 2, 0)
	InterfaceID. More...

Public Member Functions inherited from IStateful
	DeclareInterfaceID (IStateful, 1, 0)
	InterfaceID. More...

virtual	~IStateful ()

Protected Member Functions
bool	isInitialized () const
	Has the Algorithm already been initialized? More...

bool	isFinalized () const
	Has the Algorithm already been finalized? More...

int	outputLevel () const
	retrieve the Algorithm output level More...

IntegerProperty &	outputLevelProperty ()
	Accessor for the Message level property. More...

void	initOutputLevel (Property &prop)
	callback for output level property More...

Private Member Functions
StatusCode	service_i (const std::string &svcName, bool createIf, const InterfaceID &iid, void **ppSvc) const
	implementation of service method More...

StatusCode	service_i (const std::string &svcType, const std::string &svcName, const InterfaceID &iid, void **ppSvc) const

	Algorithm (const Algorithm &a)
	Private Copy constructor: NO COPY ALLOWED. More...

Algorithm &	operator= (const Algorithm &rhs)
	Private assignment operator: NO ASSIGNMENT ALLOWED. More...

Private Attributes
std::string	m_name
	Algorithm's name for identification. More...

std::string	m_version
	Algorithm's version. More...

std::vector< Algorithm * > *	m_subAlgms
	Sub algorithms. More...

SmartIF< IMessageSvc >	m_MS
	Message service. More...

SmartIF< IDataProviderSvc >	m_EDS
	Event data service. More...

SmartIF< IConversionSvc >	m_ECS
	Event conversion service. More...

SmartIF< IDataProviderSvc >	m_DDS
	Detector data service. More...

SmartIF< IConversionSvc >	m_DCS
	Detector conversion service. More...

SmartIF< IHistogramSvc >	m_HDS
	Histogram data service. More...

SmartIF< INTupleSvc >	m_NTS
	N tuple service. More...

SmartIF< IChronoStatSvc >	m_CSS
	Chrono & Stat Service. More...

SmartIF< IRndmGenSvc >	m_RGS
	Random Number Generator Service. More...

SmartIF< IExceptionSvc >	m_EXS
	Exception Handler Service. More...

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service. More...

SmartIF< IToolSvc >	m_ptoolSvc
	ToolSvc Service. More...

SmartIF< IMonitorSvc >	m_pMonitorSvc
	Online Monitoring Service. More...

SmartIF< IAlgContextSvc >	m_contextSvc
	Algorithm Context Service. More...

bool	m_registerContext
	flag to register for Algorithm Context Service More...

std::string	m_monitorSvcName
	Name to use for Monitor Service. More...

SmartIF< ISvcLocator >	m_pSvcLocator
	Pointer to service locator service. More...

PropertyMgr *	m_propertyMgr
	For management of properties. More...

IntegerProperty	m_outputLevel
	Algorithm output level. More...

int	m_errorMax
	Algorithm Max number of errors. More...

int	m_errorCount
	Algorithm error counter. More...

BooleanProperty	m_auditInit
	global flag for auditors More...

bool	m_auditorInitialize
	flag for auditors in "initialize()" More...

bool	m_auditorReinitialize
	flag for auditors in "Reinitialize()" More...

bool	m_auditorRestart
	flag for auditors in "Restart()" More...

bool	m_auditorExecute
	flag for auditors in "execute()" More...

bool	m_auditorFinalize
	flag for auditors in "finalize()" More...

bool	m_auditorBeginRun
	flag for auditors in "beginRun()" More...

bool	m_auditorEndRun
	flag for auditors in "endRun()" More...

bool	m_auditorStart
	flag for auditors in "initialize()" More...

bool	m_auditorStop
	flag for auditors in "Reinitialize()" More...

bool	m_filterPassed
	Filter passed flag. More...

bool	m_isEnabled
	Algorithm is enabled flag. More...

bool	m_isExecuted
	Algorithm is executed flag. More...

Gaudi::StateMachine::State	m_state
	Algorithm has been initialized flag. More...

Gaudi::StateMachine::State	m_targetState
	Algorithm has been initialized flag. More...

bool	m_isFinalized
	Algorithm has been finalized flag. More...

Additional Inherited Members
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

Detailed Description

Base class from which all concrete algorithm classes should be derived.

In order for a concrete algorithm class to do anything useful the methods initialize(), execute() and finalize() should be overridden.

The base class provides utility methods for accessing standard services (event data service etc.); for declaring properties which may be configured by the job options service; and for creating sub algorithms. The only base class functionality which may be used in the constructor of a concrete algorithm is the declaration of member variables as properties. All other functionality, i.e. the use of services and the creation of sub-algorithms, may be used only in initialize() and afterwards (see the Gaudi user guide).

Author: Paul Maley; Pere Mato; David Quarrie

Date: 1998

Definition at line 61 of file Algorithm.h.

Member Typedef Documentation

typedef Gaudi::PluginService::Factory2<IAlgorithm*, const std::string&, ISvcLocator*> Algorithm::Factory

Definition at line 65 of file Algorithm.h.

Constructor & Destructor Documentation

Algorithm::Algorithm	(	const std::string &	name,
		ISvcLocator *	svcloc,
		const std::string &	version = `PACKAGE_VERSION`
	)

Constructor.

Parameters

name	The algorithm object's name
svcloc	A pointer to a service location service

Definition at line 28 of file Algorithm.cpp.

 {
   StatusCode sc = StatusCode::FAILURE;
   // check arguments
   if ( 0 == self || 0 == method ) { return StatusCode::FAILURE ; }
 
   // call Python
   PyObject* r = PyObject_CallMethod(self, chr(method), chr(""));
 
   if ( 0 == r ) { PyErr_Print() ;              return sc ; } // RETURN
 
   if ( PyInt_Check ( r ) )
   { sc = PyInt_AS_LONG( r ) ; Py_DECREF( r ) ; return sc ; } // RETURN
 
   // look for the method getCode with the signature:
   //  ' int getCode() '
   PyObject* c = PyObject_CallMethod(r, chr("getCode"), chr(""));
 
   if      ( 0 == c           ) {      PyErr_Print()      ; }
   else if ( PyLong_Check( c )) { sc = PyLong_AsLong( c ); }
   else
   {
     std::string msg( " call_python_method unexpected type from '" );
     msg += method ;
     msg += "().getCode()' " ;
     PyErr_SetString( PyExc_TypeError , msg.c_str() ) ;
     PyErr_Print() ;
   }
   // release used objects
   Py_XDECREF( c ) ;
   Py_XDECREF( r ) ;
   //
   return sc;
 }
 // ============================================================================
 
 // ============================================================================
 // ============================================================================
 GaudiPython::PyAlgorithm::PyAlgorithm
 ( PyObject*          self ,
   const std::string& name )
   : Algorithm ( name , Gaudi::svcLocator() )
   , m_self ( self )
 {
   // The owner of the Algorithm is Python (as creator) therefore
   // it should not be deleted by Gaudi (added an extra addRef()).
   addRef() ;
   addRef() ;
 }
 // ============================================================================
 

Algorithm::~Algorithm ( )

virtual

Destructor.

Definition at line 87 of file Algorithm.cpp.

 { return GaudiPython::call_python_method ( m_self , "initialize" ) ; }
 // ============================================================================
 StatusCode GaudiPython::PyAlgorithm::start ()
 { return GaudiPython::call_python_method ( m_self , "start" ) ; }

Algorithm::Algorithm ( const Algorithm & a )

private

Private Copy constructor: NO COPY ALLOWED.

Member Function Documentation

SmartIF<IAuditorSvc>& Algorithm::auditorSvc ( ) const

The standard auditor service.May not be invoked before sysInitialize() has been invoked.

StatusCode Algorithm::beginRun ( )

virtual

Algorithm begin run.

This method is called at the beginning of the event loop.

Implements IAlgorithm.

Reimplemented in Sequencer, GaudiPython::PyAlgorithm, GaudiSequencer, and HelloWorld.

Definition at line 497 of file Algorithm.cpp.

m_CSS m_DCS m_ECS m_EXS m_RGS m_contextSvc SmartIF< IChronoStatSvc > & Algorithm::chronoStatService ( ) const

Obsoleted name, kept due to the backwards compatibility.

Definition at line 923 of file Algorithm.cpp.

SmartIF<IChronoStatSvc>& Algorithm::chronoSvc ( ) const

The standard Chrono & Stat service, Return a pointer to the service if present.

virtual StatusCode Algorithm::configure ( )

inlinevirtual

Dummy implementation of IStateful::configure() method.

Implements IAlgorithm.

Definition at line 150 of file Algorithm.h.

150 { return StatusCode::SUCCESS ; }

StatusCode::SUCCESS

Definition: StatusCode.h:34

SmartIF<IAlgContextSvc>& Algorithm::contextSvc ( ) const

get Algorithm Context Service

StatusCode Algorithm::createSubAlgorithm	(	const std::string &	type,
		const std::string &	name,
		Algorithm *&	pSubAlg
	)

Create a sub algorithm.

A call to this method creates a child algorithm object. Note that the returned pointer is to Algorithm (as opposed to IAlgorithm), and thus the methods of IProperty are also available for the direct setting of the sub-algorithm's properties. Using this mechanism instead of creating daughter algorithms directly via the new operator is prefered since then the framework may take care of all of the necessary book-keeping.

Parameters

type	The concrete algorithm class of the sub algorithm
name	The name to be given to the sub algorithm
pSubAlg	Set to point to the newly created algorithm object

Definition at line 1116 of file Algorithm.cpp.

template<class T >

void Algorithm::declareInfo	(	const std::string &	name,
		const T &	var,
		const std::string &	desc
	)		const

inline

Declare monitoring information.

Parameters

name	Monitoring information name known to the external system
var	Monitoring Listener address (the item to monitor...)
desc	Textual description of the information being monitored

Definition at line 435 of file Algorithm.h.

   {
     IMonitorSvc* mS = monitorSvc().get();
     if ( mS ) mS->declareInfo(name, var, desc, this);
   }

void Algorithm::declareInfo	(	const std::string &	name,
		const std::string &	format,
		const void *	var,
		int	size,
		const std::string &	desc
	)		const

inline

Declare monitoring information (special case)

Parameters

name	Monitoring information name known to the external system
format	Format information
var	Monitoring Listener address
size	Monitoring Listener address size
desc	Textual description of the information being monitored

Definition at line 450 of file Algorithm.h.

   {
     IMonitorSvc* mS = monitorSvc().get();
     if ( mS ) mS->declareInfo(name, format, var, size, desc, this);
   }

template<class T >

Property* Algorithm::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)		const

inline

Declare the named property.

MyAlg ( const std::string& name ,
        ISvcLocator*       pSvc )
   : Algorithm ( name , pSvc )
   , m_property1   ( ... )
   , m_property2   ( ... )
 {
   // declare the property
   declareProperty( "Property1" , m_property1 , "Doc for property #1" ) ;
   // declare the property and attach the handler to it
   declareProperty( "Property2" , m_property2 , "Doc for property #2" )
      -> declareUpdateHandler( &MyAlg::handler_2 ) ;
 }

See also: PropertyMgr; PropertyMgr::declareProperty

Parameters

name	the property name
property	the property itself,
doc	the documentation string

Returns: the actual property objects

Definition at line 395 of file Algorithm.h.

   {
     return m_propertyMgr->declareProperty(name, property, doc);
   }

Property* Algorithm::declareRemoteProperty	(	const std::string &	name,
		IProperty *	rsvc,
		const std::string &	rname = `""`
	)		const

inline

Declare remote named properties.

Definition at line 404 of file Algorithm.h.

   {
     return m_propertyMgr -> declareRemoteProperty ( name , rsvc , rname );
   }

SmartIF<IConversionSvc>& Algorithm::detCnvSvc ( ) const

The standard detector data persistency conversion service.

May not be invoked before sysInitialize() has been invoked.

SmartIF< IConversionSvc > & Algorithm::detDataCnvService ( ) const

Obsoleted name, kept due to the backwards compatibility.

Definition at line 931 of file Algorithm.cpp.

SmartIF< IDataProviderSvc > & Algorithm::detDataService ( ) const

Obsoleted name, kept due to the backwards compatibility.

Definition at line 927 of file Algorithm.cpp.

SmartIF<IDataProviderSvc>& Algorithm::detSvc ( ) const

The standard detector data service.

May not be invoked before sysInitialize() has been invoked.

StatusCode Algorithm::endRun ( )

virtual

Algorithm end run. This method is called at the end of the event loop.

Implements IAlgorithm.

Reimplemented in Sequencer, GaudiPython::PyAlgorithm, GaudiSequencer, and HelloWorld.

Definition at line 573 of file Algorithm.cpp.

SmartIF<IConversionSvc>& Algorithm::eventCnvSvc ( ) const

The standard event data persistency conversion service.

May not be invoked before sysInitialize() has been invoked.

SmartIF< IConversionSvc > & Algorithm::eventDataCnvService ( ) const

Obsoleted name, kept due to the backwards compatibility.

Definition at line 939 of file Algorithm.cpp.

SmartIF< IDataProviderSvc > & Algorithm::eventDataService ( ) const

Obsoleted name, kept due to the backwards compatibility.

Definition at line 935 of file Algorithm.cpp.

SmartIF<IDataProviderSvc>& Algorithm::eventSvc ( ) const

The standard event data service.

May not be invoked before sysInitialize() has been invoked.

SmartIF<IDataProviderSvc>& Algorithm::evtSvc ( ) const

inline

shortcut for method eventSvc

Definition at line 255 of file Algorithm.h.

255 { return eventSvc() ; }

Algorithm::eventSvc

SmartIF< IDataProviderSvc > & eventSvc() const

The standard event data service.

SmartIF<IExceptionSvc>& Algorithm::exceptionSvc ( ) const

Get the exception Service.

bool Algorithm::filterPassed ( ) const

virtual

Did this algorithm pass or fail its filter criterion for the last event?

Implements IAlgorithm.

Definition at line 862 of file Algorithm.cpp.

virtual StatusCode Algorithm::finalize ( )

inlinevirtual

the default (empty) implementation of IStateful::finalize() method

Implements IAlgorithm.

Reimplemented in GaudiHistos< GaudiAlgorithm >, GaudiCommon< Algorithm >, GaudiTuples< GaudiHistoAlg >, StoreExplorerAlg, CollectionCloneAlg, OutputStream, GaudiAlgorithm, TagCollectionStream, StoreSnifferAlg, Sequencer, PartitionSwitchAlg, GaudiTupleAlg, GaudiHistoAlg, EvtCollectionStream, GaudiPython::PyAlgorithm, RandomNumberAlg, GaudiSequencer, InputCopyStream, RecordOutputStream, ReplayOutputStream, Prescaler, WriteAlg, EventCounter, HelloWorld, PropertyAlg, RecordStream, and RunRecordStream.

Definition at line 161 of file Algorithm.h.

161 { return StatusCode::SUCCESS ; }

StatusCode::SUCCESS

Definition: StatusCode.h:34

virtual Gaudi::StateMachine::State Algorithm::FSMState ( ) const

inlinevirtual

returns the current state of the algorithm

Implements IAlgorithm.

Definition at line 188 of file Algorithm.h.

188 { return m_state; }

Algorithm::m_state

Gaudi::StateMachine::State m_state

Algorithm has been initialized flag.

Definition: Algorithm.h:569

const std::vector< Property * > & Algorithm::getProperties ( ) const

virtual

Implementation of IProperty::getProperties.

Implements IProperty.

Definition at line 1159 of file Algorithm.cpp.

StatusCode Algorithm::getProperty ( Property * p ) const

virtual

Implementation of IProperty::getProperty.

Implements IProperty.

Definition at line 1150 of file Algorithm.cpp.

const Property & Algorithm::getProperty ( const std::string & name ) const

virtual

Implementation of IProperty::getProperty.

Implements IProperty.

Definition at line 1153 of file Algorithm.cpp.

StatusCode Algorithm::getProperty	(	const std::string &	n,
		std::string &	v
	)		const

virtual

Implementation of IProperty::getProperty.

Implements IProperty.

Definition at line 1156 of file Algorithm.cpp.

SmartIF< IHistogramSvc > & Algorithm::histogramDataService ( ) const

Obsoleted name, kept due to the backwards compatibility.

Definition at line 943 of file Algorithm.cpp.

SmartIF<IHistogramSvc>& Algorithm::histoSvc ( ) const

The standard histogram service.

May not be invoked before sysInitialize() has been invoked.

virtual StatusCode Algorithm::initialize ( )

inlinevirtual

the default (empty) implementation of IStateful::initialize() method

Implements IAlgorithm.

Reimplemented in GaudiHistos< GaudiAlgorithm >, GaudiCommon< Algorithm >, GaudiTuples< GaudiHistoAlg >, StoreExplorerAlg, CollectionCloneAlg, OutputStream, TagCollectionStream, GaudiAlgorithm, StoreSnifferAlg, GaudiTupleAlg, GaudiHistoAlg, PartitionSwitchAlg, EvtCollectionStream, Sequencer, GaudiPython::PyAlgorithm, RandomNumberAlg, GaudiSequencer, InputCopyStream, RecordOutputStream, Prescaler, ReplayOutputStream, WriteAlg, EventCounter, HelloWorld, and PropertyAlg.

Definition at line 155 of file Algorithm.h.

155 { return StatusCode::SUCCESS ; }

StatusCode::SUCCESS

Definition: StatusCode.h:34

void Algorithm::initOutputLevel ( Property & prop )

protected

callback for output level property

Protected Member Functions.

Definition at line 1167 of file Algorithm.cpp.

bool Algorithm::isEnabled ( ) const

virtual

Is this algorithm enabled or disabled?

Implements IAlgorithm.

Definition at line 858 of file Algorithm.cpp.

bool Algorithm::isExecuted ( ) const

virtual

Has this algorithm been executed since the last reset?

Implements IAlgorithm.

Definition at line 845 of file Algorithm.cpp.

bool Algorithm::isFinalized ( ) const

inlineprotectedvirtual

Has the Algorithm already been finalized?

Implements IAlgorithm.

Definition at line 516 of file Algorithm.h.

516 { return Gaudi::StateMachine::CONFIGURED == m_state; }

Gaudi::StateMachine::CONFIGURED

Definition: StateMachine.h:14

Algorithm::m_state

Gaudi::StateMachine::State m_state

Algorithm has been initialized flag.

Definition: Algorithm.h:569

bool Algorithm::isInitialized ( ) const

inlineprotectedvirtual

Has the Algorithm already been initialized?

Implements IAlgorithm.

Definition at line 513 of file Algorithm.h.

513 { return Gaudi::StateMachine::INITIALIZED == m_state; }

Gaudi::StateMachine::INITIALIZED

Definition: StateMachine.h:15

Algorithm::m_state

Gaudi::StateMachine::State m_state

Algorithm has been initialized flag.

Definition: Algorithm.h:569

SmartIF< IMessageSvc > & Algorithm::messageService ( ) const

Obsoleted name, kept due to the backwards compatibility.

Definition at line 947 of file Algorithm.cpp.

SmartIF<IMonitorSvc>& Algorithm::monitorSvc ( ) const

inline

Access the monitor service.

Attention: Note that this method will return a NULL pointer if no monitor service is configured to be present. You must take this possibility into account when using the pointer

Returns: Pointer to the Monitor service

Return values

NULL	No monitor service is present
non-NULL	A monitor service is present and available to be used

Definition at line 420 of file Algorithm.h.

   {
     // If not already located try to locate it without forcing a creation
     if ( !m_pMonitorSvc.isValid() ){
       m_pMonitorSvc = service(m_monitorSvcName, false, true); // do not create and be quiet
     }
     return m_pMonitorSvc;
   }

SmartIF< IMessageSvc > & Algorithm::msgSvc ( ) const

The standard message service.

Returns a pointer to the standard message service. May not be invoked before sysInitialize() has been invoked.

Definition at line 896 of file Algorithm.cpp.

const std::string & Algorithm::name ( ) const

virtual

The identifying name of the algorithm object.

This is the name of a particular instantiation of an algorithm object as opposed to the name of the algorithm itself, e.g. "LinearTrackFit" may be the name of a concrete algorithm class, whereas "ApproxTrackFit" and "BestTrackFit" may be two instantiations of the class configured to find tracks with different fit criteria.

Implements INamedInterface.

Definition at line 837 of file Algorithm.cpp.

SmartIF< INTupleSvc > & Algorithm::ntupleService ( ) const

Obsoleted name, kept due to the backwards compatibility.

Definition at line 951 of file Algorithm.cpp.

SmartIF<INTupleSvc>& Algorithm::ntupleSvc ( ) const

The standard N tuple service.

Returns a pointer to the N tuple service if present.

Algorithm& Algorithm::operator= ( const Algorithm & rhs )

private

Private assignment operator: NO ASSIGNMENT ALLOWED.

int Algorithm::outputLevel ( ) const

inlineprotected

retrieve the Algorithm output level

Definition at line 519 of file Algorithm.h.

519 { return (int)m_outputLevel ; }

Algorithm::m_outputLevel

IntegerProperty m_outputLevel

Algorithm output level.

Definition: Algorithm.h:553

IntegerProperty& Algorithm::outputLevelProperty ( )

inlineprotected

Accessor for the Message level property.

Definition at line 522 of file Algorithm.h.

522 { return m_outputLevel; }

Algorithm::m_outputLevel

IntegerProperty m_outputLevel

Algorithm output level.

Definition: Algorithm.h:553

SmartIF<IRndmGenSvc>& Algorithm::randSvc ( ) const

AIDA-based NTuple service Returns a pointer to the AIDATuple service if present.

The standard RandomGen service, Return a pointer to the service if present

bool Algorithm::registerContext ( ) const

inline

register for Algorithm Context Service?

Definition at line 320 of file Algorithm.h.

320 { return m_registerContext ; }

Algorithm::m_registerContext

bool m_registerContext

flag to register for Algorithm Context Service

Definition: Algorithm.h:549

StatusCode Algorithm::reinitialize ( )

virtual

the default (empty) implementation of IStateful::reinitialize() method

Implements IAlgorithm.

Reimplemented in Sequencer.

Definition at line 798 of file Algorithm.cpp.

void Algorithm::resetExecuted ( )

virtual

Reset the executed state of the Algorithm for the duration of the current event.

Implements IAlgorithm.

Reimplemented in Sequencer, and GaudiSequencer.

Definition at line 853 of file Algorithm.cpp.

StatusCode Algorithm::restart ( )

virtual

the default (empty) implementation of IStateful::restart() method

Implements IAlgorithm.

Definition at line 820 of file Algorithm.cpp.

template<class T >

StatusCode Algorithm::service	(	const std::string &	name,
		T *&	psvc,
		bool	createIf = `true`
	)		const

inline

Access a service by name, creating it if it doesn't already exist.

Definition at line 205 of file Algorithm.h.

                                                                   {
     return service_i(name, createIf, T::interfaceID(), (void**)&psvc);
   }

template<class T >

StatusCode Algorithm::service	(	const std::string &	svcType,
		const std::string &	svcName,
		T *&	psvc
	)		const

inline

Access a service by name and type, creating it if it doesn't already exist.

Definition at line 211 of file Algorithm.h.

                                       {
     return service_i(svcType, svcName, T::interfaceID(), (void**)&psvc);
   }

SmartIF< IService > Algorithm::service	(	const std::string &	name,
		const bool	createIf = `true`,
		const bool	quiet = `false`
	)		const

Return a pointer to the service identified by name (or "type/name")

Definition at line 1190 of file Algorithm.cpp.

StatusCode Algorithm::service_i	(	const std::string &	svcName,
		bool	createIf,
		const InterfaceID &	iid,
		void **	ppSvc
	)		const

private

implementation of service method

Definition at line 1173 of file Algorithm.cpp.

StatusCode Algorithm::service_i	(	const std::string &	svcType,
		const std::string &	svcName,
		const InterfaceID &	iid,
		void **	ppSvc
	)		const

private

Definition at line 1182 of file Algorithm.cpp.

SmartIF< ISvcLocator > & Algorithm::serviceLocator ( ) const

The standard service locator.

Returns a pointer to the service locator service. This service may be used by an algorithm to request any services it requires in addition to those provided by default.

Definition at line 1091 of file Algorithm.cpp.

void Algorithm::setExecuted ( bool state )

virtual

Set the executed flag to the specified state.

Implements IAlgorithm.

Definition at line 849 of file Algorithm.cpp.

void Algorithm::setFilterPassed ( bool state )

virtual

Set the filter passed flag to the specified state.

Implements IAlgorithm.

Definition at line 866 of file Algorithm.cpp.

void Algorithm::setOutputLevel ( int level )

Set the output level for current algorithm.

Definition at line 874 of file Algorithm.cpp.

StatusCode Algorithm::setProperties ( )

Set the algorithm's properties.

This method requests the job options service to set the values of any declared properties. The method is invoked from within sysInitialize() by the framework and does not need to be explicitly called by a concrete algorithm.

Definition at line 1096 of file Algorithm.cpp.

StatusCode Algorithm::setProperty ( const Property & p )

virtual

Implementation of IProperty::setProperty.

Implements IProperty.

Definition at line 1141 of file Algorithm.cpp.

StatusCode Algorithm::setProperty ( const std::string & s )

virtual

Implementation of IProperty::setProperty.

Implements IProperty.

Definition at line 1144 of file Algorithm.cpp.

StatusCode Algorithm::setProperty	(	const std::string &	n,
		const std::string &	v
	)

virtual

Implementation of IProperty::setProperty.

Implements IProperty.

Definition at line 1147 of file Algorithm.cpp.

template<class TYPE >

StatusCode Algorithm::setProperty	(	const std::string &	name,
		const TYPE &	value
	)

inline

set the property form the value

std::vector<double> data = ... ;
setProperty( "Data" , data ) ;
std::map<std::string,double> cuts = ... ;
setProperty( "Cuts" , cuts ) ;
std::map<std::string,std::string> dict = ... ;
setProperty( "Dictionary" , dict ) ;

Note: the interface IProperty allows setting of the properties either directly from other properties or from strings only

This is very convenient in resetting of the default properties in the derived classes. E.g. without this method one needs to convert everything into strings to use IProperty::setProperty

setProperty ( "OutputLevel" , "1"    ) ;
setProperty ( "Enable"      , "True" ) ;
setProperty ( "ErrorMax"    , "10"   ) ;

For simple cases it is more or less ok, but for complicated properties it is just ugly..

Parameters

name	name of the property
value	value of the property

See also: Gaudi::Utils::setProperty

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-05-13

Definition at line 506 of file Algorithm.h.

508 { return Gaudi::Utils::setProperty ( m_propertyMgr , name , value ) ; }

Gaudi::Utils::setProperty

StatusCode setProperty(IProperty *component, const std::string &name, const TYPE &value, const std::string &doc)

simple function to set the property of the given object from the value

Definition: Property.h:1212

Algorithm::m_propertyMgr

PropertyMgr * m_propertyMgr

For management of properties.

Definition: Algorithm.h:552

Algorithm::name

virtual const std::string & name() const

The identifying name of the algorithm object.

Definition: Algorithm.cpp:837

dump_component_properties.value

list value

Definition: dump_component_properties.py:12

virtual StatusCode Algorithm::start ( )

inlinevirtual

the default (empty) implementation of IStateful::start() method

Implements IAlgorithm.

Reimplemented in Sequencer, GaudiPython::PyAlgorithm, and ReplayOutputStream.

Definition at line 157 of file Algorithm.h.

157 { return StatusCode::SUCCESS ; }

StatusCode::SUCCESS

Definition: StatusCode.h:34

virtual StatusCode Algorithm::stop ( )

inlinevirtual

the default (empty) implementation of IStateful::stop() method

Implements IAlgorithm.

Reimplemented in Sequencer, GaudiPython::PyAlgorithm, and ReplayOutputStream.

Definition at line 159 of file Algorithm.h.

159 { return StatusCode::SUCCESS ; }

StatusCode::SUCCESS

Definition: StatusCode.h:34

std::vector< Algorithm * > * Algorithm::subAlgorithms ( ) const

List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms.

Definition at line 870 of file Algorithm.cpp.

SmartIF<ISvcLocator>& Algorithm::svcLoc ( ) const

inline

shortcut for method serviceLocator

Definition at line 317 of file Algorithm.h.

317 { return serviceLocator() ; }

Algorithm::serviceLocator

SmartIF< ISvcLocator > & serviceLocator() const

The standard service locator.

Definition: Algorithm.cpp:1091

StatusCode Algorithm::sysBeginRun ( )

virtual

beginRun method invoked by the framework.

This method is responsible for any beginRun actions required by the framework itself. It will in turn invoke the beginRun() method of the derived algorithm, and of any sub-algorithms which it creates.

Implements IAlgorithm.

Definition at line 426 of file Algorithm.cpp.

StatusCode Algorithm::sysEndRun ( )

virtual

endRun method invoked by the framework.

This method is responsible for any endRun actions required by the framework itself. It will in turn invoke the endRun() method of the derived algorithm, and of any sub-algorithms which it creates.

Implements IAlgorithm.

Definition at line 502 of file Algorithm.cpp.

StatusCode Algorithm::sysExecute ( )

virtual

The actions to be performed by the algorithm on an event.

This method is invoked once per event for top level algorithms by the application manager. This method invokes execute() method. For sub-algorithms either the sysExecute() method or execute() method must be EXPLICITLY invoked by the parent algorithm.

Implements IAlgorithm.

Reimplemented in GaudiAlgorithm.

Definition at line 578 of file Algorithm.cpp.

StatusCode Algorithm::sysFinalize ( )

virtual

System finalization.

This method invokes the finalize() method of a concrete algorithm and the finalize() methods of all of that algorithm's sub algorithms.

Implements IAlgorithm.

Definition at line 726 of file Algorithm.cpp.

StatusCode Algorithm::sysInitialize ( )

virtual

Initialization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself. It will in turn invoke the initialize() method of the derived algorithm, and of any sub-algorithms which it creates.

Implements IAlgorithm.

Definition at line 93 of file Algorithm.cpp.

 { return GaudiPython::call_python_method ( m_self , "execute" ) ; }
 // ============================================================================
 StatusCode GaudiPython::PyAlgorithm::stop ()
 { return GaudiPython::call_python_method ( m_self , "stop" ) ; }
 // ============================================================================
 StatusCode GaudiPython::PyAlgorithm::finalize   ()
 { return GaudiPython::call_python_method ( m_self , "finalize" ) ; }
 
 StatusCode GaudiPython::PyAlgorithm::beginRun() {
   return GaudiPython::call_python_method ( m_self , "beginRun" ) ; }
 StatusCode GaudiPython::PyAlgorithm::endRun() {
   return GaudiPython::call_python_method ( m_self , "endRun" ) ; }
 

StatusCode Algorithm::sysReinitialize ( )

virtual

Reinitialization method invoked by the framework.

This method is responsible for any reinitialization required by the framework itself. It will in turn invoke the reinitialize() method of the derived algorithm, and of any sub-algorithms which it creates.

Implements IAlgorithm.

Definition at line 259 of file Algorithm.cpp.

StatusCode Algorithm::sysRestart ( )

virtual

Restart method invoked by the framework.

It will in turn invoke the restart() method of the derived algorithm, and of any sub-algorithms which it creates.

Implements IAlgorithm.

Definition at line 343 of file Algorithm.cpp.

StatusCode Algorithm::sysStart ( )

virtual

Reinitialization method invoked by the framework.

This method is responsible for any reinitialization required by the framework itself. It will in turn invoke the reinitialize() method of the derived algorithm, and of any sub-algorithms which it creates.

Implements IAlgorithm.

Definition at line 182 of file Algorithm.cpp.

StatusCode Algorithm::sysStop ( )

virtual

System stop.

This method invokes the stop() method of a concrete algorithm and the stop() methods of all of that algorithm's sub algorithms.

Implements IAlgorithm.

Definition at line 667 of file Algorithm.cpp.

virtual Gaudi::StateMachine::State Algorithm::targetFSMState ( ) const

inlinevirtual

returns the state the algorithm will be in after the ongoing transition

Implements IStateful.

Definition at line 191 of file Algorithm.h.

191 { return m_targetState; }

Algorithm::m_targetState

Gaudi::StateMachine::State m_targetState

Algorithm has been initialized flag.

Definition: Algorithm.h:570

virtual StatusCode Algorithm::terminate ( )

inlinevirtual

Dummy implementation of IStateful::terminate() method.

Implements IAlgorithm.

Definition at line 152 of file Algorithm.h.

152 { return StatusCode::SUCCESS ; }

StatusCode::SUCCESS

Definition: StatusCode.h:34

SmartIF<IToolSvc>& Algorithm::toolSvc ( ) const

The standard ToolSvc service, Return a pointer to the service if present.

const std::string & Algorithm::version ( ) const

virtual

The version of the algorithm.

Implements IAlgorithm.

Definition at line 841 of file Algorithm.cpp.

Member Data Documentation

BooleanProperty Algorithm::m_auditInit

private

global flag for auditors

Definition at line 556 of file Algorithm.h.

bool Algorithm::m_auditorBeginRun

private

flag for auditors in "beginRun()"

Definition at line 562 of file Algorithm.h.

bool Algorithm::m_auditorEndRun

private

flag for auditors in "endRun()"

Definition at line 563 of file Algorithm.h.

bool Algorithm::m_auditorExecute

private

flag for auditors in "execute()"

Definition at line 560 of file Algorithm.h.

bool Algorithm::m_auditorFinalize

private

flag for auditors in "finalize()"

Definition at line 561 of file Algorithm.h.

bool Algorithm::m_auditorInitialize

private

flag for auditors in "initialize()"

Definition at line 557 of file Algorithm.h.

bool Algorithm::m_auditorReinitialize

private

flag for auditors in "Reinitialize()"

Definition at line 558 of file Algorithm.h.

bool Algorithm::m_auditorRestart

private

flag for auditors in "Restart()"

Definition at line 559 of file Algorithm.h.

bool Algorithm::m_auditorStart

private

flag for auditors in "initialize()"

Definition at line 564 of file Algorithm.h.

bool Algorithm::m_auditorStop

private

flag for auditors in "Reinitialize()"

Definition at line 565 of file Algorithm.h.

SmartIF<IAlgContextSvc> Algorithm::m_contextSvc

mutableprivate

Algorithm Context Service.

Definition at line 548 of file Algorithm.h.

SmartIF<IChronoStatSvc> Algorithm::m_CSS

mutableprivate

Chrono & Stat Service.

Definition at line 542 of file Algorithm.h.

SmartIF<IConversionSvc> Algorithm::m_DCS

mutableprivate

Detector conversion service.

Definition at line 538 of file Algorithm.h.

SmartIF<IDataProviderSvc> Algorithm::m_DDS

mutableprivate

Detector data service.

Definition at line 537 of file Algorithm.h.

SmartIF<IConversionSvc> Algorithm::m_ECS

mutableprivate

Event conversion service.

Definition at line 536 of file Algorithm.h.

SmartIF<IDataProviderSvc> Algorithm::m_EDS

mutableprivate

Event data service.

Definition at line 535 of file Algorithm.h.

int Algorithm::m_errorCount

private

Algorithm error counter.

Definition at line 555 of file Algorithm.h.

int Algorithm::m_errorMax

private

Algorithm Max number of errors.

Definition at line 554 of file Algorithm.h.

SmartIF<IExceptionSvc> Algorithm::m_EXS

mutableprivate

Exception Handler Service.

Definition at line 544 of file Algorithm.h.

bool Algorithm::m_filterPassed

private

Filter passed flag.

Definition at line 566 of file Algorithm.h.

SmartIF<IHistogramSvc> Algorithm::m_HDS

mutableprivate

Histogram data service.

Definition at line 539 of file Algorithm.h.

bool Algorithm::m_isEnabled

private

Algorithm is enabled flag.

Definition at line 567 of file Algorithm.h.

bool Algorithm::m_isExecuted

private

Algorithm is executed flag.

Definition at line 568 of file Algorithm.h.

bool Algorithm::m_isFinalized

private

Algorithm has been finalized flag.

Definition at line 571 of file Algorithm.h.

std::string Algorithm::m_monitorSvcName

private

Name to use for Monitor Service.

Definition at line 550 of file Algorithm.h.

SmartIF<IMessageSvc> Algorithm::m_MS

mutableprivate

Message service.

Definition at line 534 of file Algorithm.h.

std::string Algorithm::m_name

private

Algorithm's name for identification.

Definition at line 530 of file Algorithm.h.

SmartIF<INTupleSvc> Algorithm::m_NTS

mutableprivate

N tuple service.

Definition at line 540 of file Algorithm.h.

IntegerProperty Algorithm::m_outputLevel

private

Algorithm output level.

Definition at line 553 of file Algorithm.h.

SmartIF<IAuditorSvc> Algorithm::m_pAuditorSvc

mutableprivate

Auditor Service.

Definition at line 545 of file Algorithm.h.

SmartIF<IMonitorSvc> Algorithm::m_pMonitorSvc

mutableprivate

Online Monitoring Service.

Definition at line 547 of file Algorithm.h.

PropertyMgr* Algorithm::m_propertyMgr

private

For management of properties.

Definition at line 552 of file Algorithm.h.

SmartIF<ISvcLocator> Algorithm::m_pSvcLocator

private

Pointer to service locator service.

Definition at line 551 of file Algorithm.h.

SmartIF<IToolSvc> Algorithm::m_ptoolSvc

mutableprivate

ToolSvc Service.

Definition at line 546 of file Algorithm.h.

bool Algorithm::m_registerContext

private

flag to register for Algorithm Context Service

Definition at line 549 of file Algorithm.h.

SmartIF<IRndmGenSvc> Algorithm::m_RGS

mutableprivate

Random Number Generator Service.

Definition at line 543 of file Algorithm.h.

Gaudi::StateMachine::State Algorithm::m_state

private

Algorithm has been initialized flag.

Definition at line 569 of file Algorithm.h.

std::vector<Algorithm *>* Algorithm::m_subAlgms

private

Sub algorithms.

Definition at line 532 of file Algorithm.h.

Gaudi::StateMachine::State Algorithm::m_targetState

private

Algorithm has been initialized flag.

Definition at line 570 of file Algorithm.h.

std::string Algorithm::m_version

private

Algorithm's version.

Definition at line 531 of file Algorithm.h.

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

GaudiKernel/GaudiKernel/Algorithm.h
GaudiPython/src/Lib/Algorithm.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation