The Gaudi Framework: Algorithm Class Reference

Definition: StatusCode.h:30

StatusCode Algorithm::configure ( )

inlineoverride

Dummy implementation of IStateful::configure() method.

Definition at line 175 of file Algorithm.h.

175 { return StatusCode::SUCCESS ; }

Definition: StatusCode.h:30

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

get Algorithm Context Service

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 1070 of file Algorithm.cpp.

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

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 475 of file Algorithm.h.

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

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 475 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 490 of file Algorithm.h.

   {
     IMonitorSvc* mS = monitorSvc().get();
     if ( mS ) mS->declareInfo(name, format, var, size, 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 490 of file Algorithm.h.

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

template<class T >

StatusCode Algorithm::declareInput	(	const std::string &	propertyName,
		DataObjectHandle< T > &	handle,
		const std::string &	address = `DataObjectDescriptor::NULL_`,
		bool	optional = `false`,
		MinimalDataObjectHandle::AccessType	accessType = `MinimalDataObjectHandle::READ`
	)

inline

Declare input data object.

Parameters

propertyName	to identify input object in python config
handle	data handle
address	relative or absolute address in TES
optional	optional input
accessType	read, write or update

Definition at line 586 of file Algorithm.h.

                                        {
 
     bool res = m_inputDataObjects.insert(propertyName, &handle);
 
     handle.descriptor()->setTag(propertyName);
     handle.descriptor()->setAddress(address);
     handle.descriptor()->setAccessType(accessType);
     handle.descriptor()->setOptional(optional);
 
     handle.setOwner(this);
 
     MsgStream log(msgSvc(), name());
 
     if (LIKELY(res)) {
       log << MSG::DEBUG << "Handle for " << propertyName << " ("
           << address << ")" << " successfully created and stored."
           << endmsg;
     } else {
       log << MSG::ERROR << "Handle for " << propertyName << " ("
           << address << ")" << " could not be created." << endmsg;
     }
 
     return res;
 
   }

template<class T >

StatusCode Algorithm::declareInput	(	const std::string &	propertyName,
		DataObjectHandle< T > &	handle,
		const std::string &	address = `DataObjectDescriptor::NULL_`,
		bool	optional = `false`,
		MinimalDataObjectHandle::AccessType	accessType = `MinimalDataObjectHandle::READ`
	)

inline

Declare input data object.

Parameters

propertyName	to identify input object in python config
handle	data handle
address	relative or absolute address in TES
optional	optional input
accessType	read, write or update

Definition at line 586 of file Algorithm.h.

                                        {
 
     bool res = m_inputDataObjects.insert(propertyName, &handle);
 
     handle.descriptor()->setTag(propertyName);
     handle.descriptor()->setAddress(address);
     handle.descriptor()->setAccessType(accessType);
     handle.descriptor()->setOptional(optional);
 
     handle.setOwner(this);
 
     MsgStream log(msgSvc(), name());
 
     if (LIKELY(res)) {
       log << MSG::DEBUG << "Handle for " << propertyName << " ("
           << address << ")" << " successfully created and stored."
           << endmsg;
     } else {
       log << MSG::ERROR << "Handle for " << propertyName << " ("
           << address << ")" << " could not be created." << endmsg;
     }
 
     return res;
 
   }

template<class T >

StatusCode Algorithm::declareInput	(	const std::string &	propertyName,
		DataObjectHandle< T > &	handle,
		const std::vector< std::string > &	addresses,
		bool	optional = `false`,
		MinimalDataObjectHandle::AccessType	accessType = `MinimalDataObjectHandle::READ`
	)

inline

Declare input data object.

Parameters

propertyName	to identify input object in python config
handle	data handle
addresses	relative or absolute addresses in TES, first is main address
optional	optional input
accessType	read, write or update

Definition at line 625 of file Algorithm.h.

                                        {
 
     bool res = m_inputDataObjects.insert(propertyName, &handle);
 
     handle.descriptor()->setTag(propertyName);
     handle.descriptor()->setAddresses(addresses);
     handle.descriptor()->setAccessType(accessType);
     handle.descriptor()->setOptional(optional);
 
     handle.setOwner(this);
 
     MsgStream log(msgSvc(), name());
 
     if (LIKELY(res)) {
       log << MSG::DEBUG << "Handle for " << propertyName << " ("
           << (addresses.empty() ? DataObjectDescriptor::NULL_ : addresses[0]) << ")" << " successfully created and stored."
           << endmsg;
     } else {
       log << MSG::ERROR << "Handle for " << propertyName << " ("
           << (addresses.empty() ? DataObjectDescriptor::NULL_ : addresses[0]) << ")" << " could not be created." << endmsg;
     }
 
     return res;
 
   }

template<class T >

StatusCode Algorithm::declareInput	(	const std::string &	propertyName,
		DataObjectHandle< T > &	handle,
		const std::vector< std::string > &	addresses,
		bool	optional = `false`,
		MinimalDataObjectHandle::AccessType	accessType = `MinimalDataObjectHandle::READ`
	)

inline

Declare input data object.

Parameters

propertyName	to identify input object in python config
handle	data handle
addresses	relative or absolute addresses in TES, first is main address
optional	optional input
accessType	read, write or update

Definition at line 625 of file Algorithm.h.

                                        {
 
     bool res = m_inputDataObjects.insert(propertyName, &handle);
 
     handle.descriptor()->setTag(propertyName);
     handle.descriptor()->setAddresses(addresses);
     handle.descriptor()->setAccessType(accessType);
     handle.descriptor()->setOptional(optional);
 
     handle.setOwner(this);
 
     MsgStream log(msgSvc(), name());
 
     if (LIKELY(res)) {
       log << MSG::DEBUG << "Handle for " << propertyName << " ("
           << (addresses.empty() ? DataObjectDescriptor::NULL_ : addresses[0]) << ")" << " successfully created and stored."
           << endmsg;
     } else {
       log << MSG::ERROR << "Handle for " << propertyName << " ("
           << (addresses.empty() ? DataObjectDescriptor::NULL_ : addresses[0]) << ")" << " could not be created." << endmsg;
     }
 
     return res;
 
   }

template<class T >

StatusCode Algorithm::declareOutput	(	const std::string &	propertyName,
		DataObjectHandle< T > &	handle,
		const std::string &	address = `DataObjectDescriptor::NULL_`,
		bool	optional = `false`,
		MinimalDataObjectHandle::AccessType	accessType = `MinimalDataObjectHandle::WRITE`
	)

inline

Declare output data object.

Parameters

propertyName	to identify input object in python config
handle	data handle
address	relative or absolute address in TES
optional	optional input
accessType	write or update

Definition at line 663 of file Algorithm.h.

                                                                                    {
 
     bool res = m_outputDataObjects.insert(propertyName, &handle);
 
     handle.descriptor()->setTag(propertyName);
     handle.descriptor()->setAddress(address);
     handle.descriptor()->setAccessType(accessType);
     handle.descriptor()->setOptional(optional);
 
     handle.setOwner(this);
 
 
     MsgStream log(msgSvc(), name());
 
     if (LIKELY(res)) {
       log << MSG::DEBUG << "Handle for " << propertyName << " ("
           << address << ")" << " successfully created and stored."
           << endmsg;
     } else {
       log << MSG::ERROR << "Handle for " << propertyName << " ("
           << address << ")" << " could not be created." << endmsg;
     }
 
     return res;
 
   }

template<class T >

StatusCode Algorithm::declareOutput	(	const std::string &	propertyName,
		DataObjectHandle< T > &	handle,
		const std::string &	address = `DataObjectDescriptor::NULL_`,
		bool	optional = `false`,
		MinimalDataObjectHandle::AccessType	accessType = `MinimalDataObjectHandle::WRITE`
	)

inline

Declare output data object.

Parameters

propertyName	to identify input object in python config
handle	data handle
address	relative or absolute address in TES
optional	optional input
accessType	write or update

Definition at line 663 of file Algorithm.h.

                                                                                    {
 
     bool res = m_outputDataObjects.insert(propertyName, &handle);
 
     handle.descriptor()->setTag(propertyName);
     handle.descriptor()->setAddress(address);
     handle.descriptor()->setAccessType(accessType);
     handle.descriptor()->setOptional(optional);
 
     handle.setOwner(this);
 
 
     MsgStream log(msgSvc(), name());
 
     if (LIKELY(res)) {
       log << MSG::DEBUG << "Handle for " << propertyName << " ("
           << address << ")" << " successfully created and stored."
           << endmsg;
     } else {
       log << MSG::ERROR << "Handle for " << propertyName << " ("
           << address << ")" << " could not be created." << endmsg;
     }
 
     return res;
 
   }

template<class T >

StatusCode Algorithm::declarePrivateTool	(	ToolHandle< T > &	handle,
		std::string	toolTypeAndName = `""`,
		bool	createIf = `true`
	)

inline

Declare used Private tool.

Parameters

handle	ToolHandle<T>
toolTypeAndName
parent,default	public tool
create	if necessary, default true

Definition at line 736 of file Algorithm.h.

                             {
 
     if (toolTypeAndName == "")
       toolTypeAndName = System::typeinfoName(typeid(T));
 
     StatusCode sc = handle.initialize(toolTypeAndName, this, createIf);
 
     m_toolHandles.push_back(&handle);
 
     MsgStream log(msgSvc(), name());
 
     if (sc.isSuccess()) {
       log << MSG::DEBUG << "Handle for private tool" << toolTypeAndName
           << " successfully created and stored." << endmsg;
     } else {
 
       log << MSG::ERROR << "Handle for private tool" << toolTypeAndName
           << " could not be created." << endmsg;
     }
 
     return sc;
 
   }

template<class T >

StatusCode Algorithm::declarePrivateTool	(	ToolHandle< T > &	handle,
		std::string	toolTypeAndName = `""`,
		bool	createIf = `true`
	)

inline

Declare used Private tool.

Parameters

handle	ToolHandle<T>
toolTypeAndName
parent,default	public tool
create	if necessary, default true

Definition at line 736 of file Algorithm.h.

                             {
 
     if (toolTypeAndName == "")
       toolTypeAndName = System::typeinfoName(typeid(T));
 
     StatusCode sc = handle.initialize(toolTypeAndName, this, createIf);
 
     m_toolHandles.push_back(&handle);
 
     MsgStream log(msgSvc(), name());
 
     if (sc.isSuccess()) {
       log << MSG::DEBUG << "Handle for private tool" << toolTypeAndName
           << " successfully created and stored." << endmsg;
     } else {
 
       log << MSG::ERROR << "Handle for private tool" << toolTypeAndName
           << " could not be created." << endmsg;
     }
 
     return sc;
 
   }

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 435 of file Algorithm.h.

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

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 435 of file Algorithm.h.

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

template<class T >

StatusCode Algorithm::declarePublicTool	(	ToolHandle< T > &	handle,
		std::string	toolTypeAndName = `""`,
		bool	createIf = `true`
	)

inline

Declare used Public tool.

Parameters

handle	ToolHandle<T>
toolTypeAndName
parent,default	public tool
create	if necessary, default true

Definition at line 770 of file Algorithm.h.

                             {
 
     if (toolTypeAndName == "")
       toolTypeAndName = System::typeinfoName(typeid(T));
 
     StatusCode sc = handle.initialize(toolTypeAndName, 0, createIf);
 
     m_toolHandles.push_back(&handle);
 
     MsgStream log(msgSvc(), name());
 
     if (sc.isSuccess()) {
       log << MSG::DEBUG << "Handle for public tool" << toolTypeAndName
           << " successfully created and stored." << endmsg;
     } else {
 
       log << MSG::ERROR << "Handle for public tool" << toolTypeAndName
           << " could not be created." << endmsg;
     }
 
     return sc;
 
   }

template<class T >

StatusCode Algorithm::declarePublicTool	(	ToolHandle< T > &	handle,
		std::string	toolTypeAndName = `""`,
		bool	createIf = `true`
	)

inline

Declare used Public tool.

Parameters

handle	ToolHandle<T>
toolTypeAndName
parent,default	public tool
create	if necessary, default true

Definition at line 770 of file Algorithm.h.

                             {
 
     if (toolTypeAndName == "")
       toolTypeAndName = System::typeinfoName(typeid(T));
 
     StatusCode sc = handle.initialize(toolTypeAndName, 0, createIf);
 
     m_toolHandles.push_back(&handle);
 
     MsgStream log(msgSvc(), name());
 
     if (sc.isSuccess()) {
       log << MSG::DEBUG << "Handle for public tool" << toolTypeAndName
           << " successfully created and stored." << endmsg;
     } else {
 
       log << MSG::ERROR << "Handle for public tool" << toolTypeAndName
           << " could not be created." << endmsg;
     }
 
     return sc;
 
   }

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

inline

Declare remote named properties.

Definition at line 444 of file Algorithm.h.

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

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

inline

Declare remote named properties.

Definition at line 444 of file Algorithm.h.

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

void Algorithm::deregisterTool ( IAlgTool * tool ) const

inline

Definition at line 713 of file Algorithm.h.

                                              {
     std::vector<IAlgTool *>::iterator it = std::find(m_tools.begin(),
         m_tools.end(), tool);
 
     MsgStream log(msgSvc(), name());
     if (it != m_tools.end()) {
 
       log << MSG::DEBUG << "De-Registering tool " << tool->name() << endmsg;
 
       m_tools.erase(it);
     } else {
       log << MSG::DEBUG << "Could not de-register tool " << tool->name() << endmsg;
     }
   }

void Algorithm::deregisterTool ( IAlgTool * tool ) const

inline

Definition at line 713 of file Algorithm.h.

                                              {
     std::vector<IAlgTool *>::iterator it = std::find(m_tools.begin(),
         m_tools.end(), tool);
 
     MsgStream log(msgSvc(), name());
     if (it != m_tools.end()) {
 
       log << MSG::DEBUG << "De-Registering tool " << tool->name() << endmsg;
 
       m_tools.erase(it);
     } else {
       log << MSG::DEBUG << "Could not de-register tool " << tool->name() << endmsg;
     }
   }

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

The standard detector data persistency conversion service.

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

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.

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

Obsoleted name, kept due to the backwards compatibility.

Definition at line 1021 of file Algorithm.cpp.

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

Obsoleted name, kept due to the backwards compatibility.

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

Obsoleted name, kept due to the backwards compatibility.

Definition at line 1017 of file Algorithm.cpp.

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

The standard detector data service.

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

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

The standard detector data service.

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

StatusCode Algorithm::endRun ( )

override

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

StatusCode Algorithm::endRun ( )

override

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

Definition at line 647 of file Algorithm.cpp.

int Algorithm::errorCount ( ) const

inline

Get the number of failures of the algorithm.

Definition at line 226 of file Algorithm.h.

226 { return m_errorCount; }

Algorithm::m_errorCount

int m_errorCount

Algorithm error counter.

Definition: Algorithm.h:889

int Algorithm::errorCount ( ) const

inline

Get the number of failures of the algorithm.

Definition at line 226 of file Algorithm.h.

226 { return m_errorCount; }

Algorithm::m_errorCount

int m_errorCount

Algorithm error counter.

Definition: Algorithm.h:889

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

The standard event data persistency conversion service.

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

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.

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

Obsoleted name, kept due to the backwards compatibility.

Definition at line 1029 of file Algorithm.cpp.

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

Obsoleted name, kept due to the backwards compatibility.

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

Obsoleted name, kept due to the backwards compatibility.

Definition at line 1025 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::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 286 of file Algorithm.h.

286 { return eventSvc() ; }

Algorithm::eventSvc

SmartIF< IDataProviderSvc > & eventSvc() const

The standard event data service.

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

inline

shortcut for method eventSvc

Definition at line 286 of file Algorithm.h.

286 { return eventSvc() ; }

Algorithm::eventSvc

SmartIF< IDataProviderSvc > & eventSvc() const

The standard event data service.

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

Get the exception Service.

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

Get the exception Service.

bool Algorithm::filterPassed ( ) const

override

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

bool Algorithm::filterPassed ( ) const

override

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

Definition at line 948 of file Algorithm.cpp.

StatusCode Algorithm::finalize ( )

inlineoverride

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

Definition at line 186 of file Algorithm.h.

186 { return StatusCode::SUCCESS ; }

Definition: StatusCode.h:30

StatusCode Algorithm::finalize ( )

inlineoverride

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

Definition at line 186 of file Algorithm.h.

186 { return StatusCode::SUCCESS ; }

Definition: StatusCode.h:30

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

inlineoverride

returns the current state of the algorithm

Definition at line 192 of file Algorithm.h.

192 { return m_state; }

Gaudi::StateMachine::State m_state

flag indicating whether ToolHandle tools have been added to m_tools

Definition: Algorithm.h:904

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

inlineoverride

returns the current state of the algorithm

Definition at line 192 of file Algorithm.h.

192 { return m_state; }

Gaudi::StateMachine::State m_state

flag indicating whether ToolHandle tools have been added to m_tools

Definition: Algorithm.h:904

EventContext* Algorithm::getContext ( )

inline

get the context

Definition at line 553 of file Algorithm.h.

553 {return m_event_context;}

EventContext * m_event_context

Event specific data for multiple event processing.

Definition: Algorithm.h:844

EventContext* Algorithm::getContext ( )

inline

get the context

Definition at line 553 of file Algorithm.h.

553 {return m_event_context;}

EventContext * m_event_context

Event specific data for multiple event processing.

Definition: Algorithm.h:844

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

override

Implementation of IProperty::getProperties.

Definition at line 1113 of file Algorithm.cpp.

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

override

Implementation of IProperty::getProperties.

StatusCode Algorithm::getProperty ( Property * p ) const

override

Implementation of IProperty::getProperty.

Definition at line 1104 of file Algorithm.cpp.

StatusCode Algorithm::getProperty ( Property * p ) const

override

Implementation of IProperty::getProperty.

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

override

Implementation of IProperty::getProperty.

Definition at line 1107 of file Algorithm.cpp.

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

override

Implementation of IProperty::getProperty.

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

override

Implementation of IProperty::getProperty.

Definition at line 1110 of file Algorithm.cpp.

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

override

Implementation of IProperty::getProperty.

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

override

Implementation of IProperty::hasProperty.

Definition at line 1116 of file Algorithm.cpp.

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

override

Implementation of IProperty::hasProperty.

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

Obsoleted name, kept due to the backwards compatibility.

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

Obsoleted name, kept due to the backwards compatibility.

Definition at line 1033 of file Algorithm.cpp.

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

The standard histogram service.

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

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

The standard histogram service.

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

unsigned int Algorithm::index ( )

override

Definition at line 927 of file Algorithm.cpp.

unsigned int Algorithm::index ( )

override

StatusCode Algorithm::initialize ( )

inlineoverride

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

Definition at line 180 of file Algorithm.h.

180 { return StatusCode::SUCCESS ; }

Definition: StatusCode.h:30

StatusCode Algorithm::initialize ( )

inlineoverride

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

Definition at line 180 of file Algorithm.h.

180 { return StatusCode::SUCCESS ; }

Gaudi::StateMachine::CONFIGURED

Definition: StatusCode.h:30

void Algorithm::initOutputLevel ( Property & prop )

protected

Callback for output level property.

Protected Member Functions.

Definition at line 1217 of file Algorithm.cpp.

void Algorithm::initOutputLevel ( Property & prop )

protected

Callback for output level property.

void Algorithm::initToolHandles ( ) const

private

Definition at line 1134 of file Algorithm.cpp.

void Algorithm::initToolHandles ( ) const

private

__attribute__ ((deprecated)) const std const DataObjectDescriptorCollection& Algorithm::inputDataObjects ( ) const

inlineoverride

Return the handles declared in the algorithm.

Definition at line 697 of file Algorithm.h.

                                                                            {
     return m_inputDataObjects;
   }

__attribute__ ((deprecated)) const std const DataObjectDescriptorCollection& Algorithm::inputDataObjects ( ) const

inlineoverride

Return the handles declared in the algorithm.

Definition at line 697 of file Algorithm.h.

                                                                            {
     return m_inputDataObjects;
   }

DataObjectDescriptorCollection& Algorithm::inputDataObjects ( )

inlineprotected

Definition at line 799 of file Algorithm.h.

                                                       {
     return m_inputDataObjects;
   }

DataObjectDescriptorCollection& Algorithm::inputDataObjects ( )

inlineprotected

Definition at line 799 of file Algorithm.h.

                                                       {
     return m_inputDataObjects;
   }

bool Algorithm::isClonable ( ) const

inlineoverride

Specifies the clonability of the algorithm.

Definition at line 819 of file Algorithm.h.

819 { return m_isClonable; }

Algorithm::m_isClonable

bool m_isClonable

The algorithm clonability of the algorithm.

Definition: Algorithm.h:910

bool Algorithm::isClonable ( ) const

inlineoverride

Specifies the clonability of the algorithm.

Definition at line 819 of file Algorithm.h.

819 { return m_isClonable; }

Algorithm::m_isClonable

bool m_isClonable

The algorithm clonability of the algorithm.

Definition: Algorithm.h:910

bool Algorithm::isEnabled ( ) const

override

Is this algorithm enabled or disabled?

bool Algorithm::isEnabled ( ) const

override

Is this algorithm enabled or disabled?

Definition at line 944 of file Algorithm.cpp.

bool Algorithm::isExecuted ( ) const

override

Has this algorithm been executed since the last reset?

bool Algorithm::isExecuted ( ) const

override

Has this algorithm been executed since the last reset?

Definition at line 931 of file Algorithm.cpp.

bool Algorithm::isFinalized ( ) const

inlineoverrideprotected

Has the Algorithm already been finalized?

Definition at line 832 of file Algorithm.h.

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

Definition: StateMachine.h:14

Gaudi::StateMachine::CONFIGURED

Gaudi::StateMachine::State m_state

flag indicating whether ToolHandle tools have been added to m_tools

Definition: Algorithm.h:904

bool Algorithm::isFinalized ( ) const

inlineoverrideprotected

Has the Algorithm already been finalized?

Definition at line 832 of file Algorithm.h.

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

Definition: StateMachine.h:14

Gaudi::StateMachine::INITIALIZED

Gaudi::StateMachine::State m_state

flag indicating whether ToolHandle tools have been added to m_tools

Definition: Algorithm.h:904

bool Algorithm::isInitialized ( ) const

inlineoverrideprotected

Has the Algorithm already been initialized?

Definition at line 829 of file Algorithm.h.

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

Definition: StateMachine.h:15

Gaudi::StateMachine::INITIALIZED

Gaudi::StateMachine::State m_state

flag indicating whether ToolHandle tools have been added to m_tools

Definition: Algorithm.h:904

bool Algorithm::isInitialized ( ) const

inlineoverrideprotected

Has the Algorithm already been initialized?

Definition at line 829 of file Algorithm.h.

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

Definition: StateMachine.h:15

Algorithm::m_neededResources

Gaudi::StateMachine::State m_state

flag indicating whether ToolHandle tools have been added to m_tools

Definition: Algorithm.h:904

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

Obsoleted name, kept due to the backwards compatibility.

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

Obsoleted name, kept due to the backwards compatibility.

Definition at line 1037 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 460 of file Algorithm.h.

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

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 460 of file Algorithm.h.

   {
     // If not already located try to locate it without forcing a creation
     if ( !m_pMonitorSvc ){
       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.

m_CSS m_DCS m_WB m_HDS m_NTS m_ptoolSvc m_timelineSvc 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 1001 of file Algorithm.cpp.

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

override

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.

Definition at line 919 of file Algorithm.cpp.

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

override

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.

const std::vector<std::string>& Algorithm::neededResources ( ) const

inlineoverride

Definition at line 824 of file Algorithm.h.

824 { return m_neededResources; }

std::vector< std::string > m_neededResources

The named resources needed during event looping.

Definition: Algorithm.h:912

const std::vector<std::string>& Algorithm::neededResources ( ) const

inlineoverride

Definition at line 824 of file Algorithm.h.

824 { return m_neededResources; }

Algorithm::m_neededResources

std::vector< std::string > m_neededResources

The named resources needed during event looping.

Definition: Algorithm.h:912

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

Obsoleted name, kept due to the backwards compatibility.

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

Obsoleted name, kept due to the backwards compatibility.

Definition at line 1041 of file Algorithm.cpp.

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

The standard N tuple service.

Returns a pointer to the N tuple service if present.

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.

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

private

Private assignment operator: NO ASSIGNMENT ALLOWED.

const DataObjectDescriptorCollection& Algorithm::outputDataObjects ( ) const

inlineoverride

Definition at line 700 of file Algorithm.h.

                                                                             {
     return m_outputDataObjects;
   }

const DataObjectDescriptorCollection& Algorithm::outputDataObjects ( ) const

inlineoverride

Definition at line 700 of file Algorithm.h.

                                                                             {
     return m_outputDataObjects;
   }

DataObjectDescriptorCollection& Algorithm::outputDataObjects ( )

inlineprotected

Definition at line 802 of file Algorithm.h.

                                                        {
     return m_outputDataObjects;
   }

DataObjectDescriptorCollection& Algorithm::outputDataObjects ( )

inlineprotected

Definition at line 802 of file Algorithm.h.

                                                        {
     return m_outputDataObjects;
   }

int Algorithm::outputLevel ( ) const

inlineprotected

retrieve the Algorithm output level

Definition at line 835 of file Algorithm.h.

835 { return (int)m_outputLevel ; }

IntegerProperty m_outputLevel

Algorithm output level.

Definition: Algorithm.h:887

int Algorithm::outputLevel ( ) const

inlineprotected

retrieve the Algorithm output level

Definition at line 835 of file Algorithm.h.

835 { return (int)m_outputLevel ; }

IntegerProperty m_outputLevel

Algorithm output level.

Definition: Algorithm.h:887

IntegerProperty& Algorithm::outputLevelProperty ( )

inlineprotected

Accessor for the Message level property.

Definition at line 838 of file Algorithm.h.

838 { return m_outputLevel; }

IntegerProperty m_outputLevel

Algorithm output level.

Definition: Algorithm.h:887

IntegerProperty& Algorithm::outputLevelProperty ( )

inlineprotected

Accessor for the Message level property.

Definition at line 838 of file Algorithm.h.

838 { return m_outputLevel; }

Algorithm::m_registerContext

IntegerProperty m_outputLevel

Algorithm output level.

Definition: Algorithm.h:887

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

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 355 of file Algorithm.h.

355 { return m_registerContext ; }

bool m_registerContext

flag to register for Algorithm Context Service

Definition: Algorithm.h:883

bool Algorithm::registerContext ( ) const

inline

register for Algorithm Context Service?

Definition at line 355 of file Algorithm.h.

355 { return m_registerContext ; }

Algorithm::m_registerContext

bool m_registerContext

flag to register for Algorithm Context Service

Definition: Algorithm.h:883

void Algorithm::registerTool ( IAlgTool * tool ) const

inline

Definition at line 704 of file Algorithm.h.

                                            {
 
     MsgStream log(msgSvc(), name());
 
     log << MSG::DEBUG << "Registering tool " << tool->name() << endmsg;
 
     m_tools.push_back(tool);
   }

void Algorithm::registerTool ( IAlgTool * tool ) const

inline

Definition at line 704 of file Algorithm.h.

                                            {
 
     MsgStream log(msgSvc(), name());
 
     log << MSG::DEBUG << "Registering tool " << tool->name() << endmsg;
 
     m_tools.push_back(tool);
   }

StatusCode Algorithm::reinitialize ( )

override

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

StatusCode Algorithm::reinitialize ( )

override

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

Definition at line 880 of file Algorithm.cpp.

void Algorithm::resetExecuted ( )

override

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

void Algorithm::resetExecuted ( )

override

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

Definition at line 939 of file Algorithm.cpp.

StatusCode Algorithm::restart ( )

override

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

StatusCode Algorithm::restart ( )

override

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

Definition at line 902 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 231 of file Algorithm.h.

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

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 231 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 237 of file Algorithm.h.

                                       {
     return service_i(svcType, svcName, 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 237 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")

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 1240 of file Algorithm.cpp.

template<class T >

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

inline

Definition at line 246 of file Algorithm.h.

                                                                                               {
     return service(name,createIf,quiet).as<T>();
   }

template<class T >

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

inline

Definition at line 246 of file Algorithm.h.

                                                                                               {
     return service(name,createIf,quiet).as<T>();
   }

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

private

implementation of service method

Definition at line 1223 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

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

private

Definition at line 1232 of file Algorithm.cpp.

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

private

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.

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 1045 of file Algorithm.cpp.

void Algorithm::setContext ( EventContext * context )

inline

set the context

Definition at line 556 of file Algorithm.h.

556 {m_event_context = context;}

EventContext * m_event_context

Event specific data for multiple event processing.

Definition: Algorithm.h:844

void Algorithm::setContext ( EventContext * context )

inline

set the context

Definition at line 556 of file Algorithm.h.

556 {m_event_context = context;}

Gaudi::Utils::setProperty

EventContext * m_event_context

Event specific data for multiple event processing.

Definition: Algorithm.h:844

void Algorithm::setExecuted ( bool state )

override

Set the executed flag to the specified state.

Definition at line 935 of file Algorithm.cpp.

void Algorithm::setExecuted ( bool state )

override

Set the executed flag to the specified state.

void Algorithm::setFilterPassed ( bool state )

override

Set the filter passed flag to the specified state.

void Algorithm::setFilterPassed ( bool state )

override

Set the filter passed flag to the specified state.

Definition at line 952 of file Algorithm.cpp.

void Algorithm::setOutputLevel ( int level )

Set the output level for current algorithm.

void Algorithm::setOutputLevel ( int level )

Set the output level for current algorithm.

Definition at line 964 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.

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 1050 of file Algorithm.cpp.

StatusCode Algorithm::setProperty ( const Property & p )

override

Implementation of IProperty::setProperty.

Definition at line 1095 of file Algorithm.cpp.

StatusCode Algorithm::setProperty ( const Property & p )

override

Implementation of IProperty::setProperty.

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

override

Implementation of IProperty::setProperty.

Definition at line 1098 of file Algorithm.cpp.

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

override

Implementation of IProperty::setProperty.

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

override

Implementation of IProperty::setProperty.

Definition at line 1101 of file Algorithm.cpp.

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

override

Implementation of IProperty::setProperty.

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 546 of file Algorithm.h.

548 { return Gaudi::Utils::setProperty ( m_propertyMgr.get() , name , value ) ; }

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:1187

Algorithm::name

const std::string & name() const override

The identifying name of the algorithm object.

Definition: Algorithm.cpp:919

SmartIF::get

TYPE * get() const

Get interface pointer.

Definition: SmartIF.h:76

Algorithm::m_propertyMgr

SmartIF< PropertyMgr > m_propertyMgr

For management of properties.

Definition: Algorithm.h:886

dump_component_properties.value

list value

Definition: dump_component_properties.py:12

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 546 of file Algorithm.h.

548 { return Gaudi::Utils::setProperty ( m_propertyMgr.get() , 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:1187

Algorithm::name

const std::string & name() const override

The identifying name of the algorithm object.

Definition: Algorithm.cpp:919

SmartIF::get

TYPE * get() const

Get interface pointer.

Definition: SmartIF.h:76

Algorithm::m_propertyMgr

SmartIF< PropertyMgr > m_propertyMgr

For management of properties.

Definition: Algorithm.h:886

dump_component_properties.value

list value

Definition: dump_component_properties.py:12

void Algorithm::setType ( const std::string & type )

inlineoverride

Definition at line 168 of file Algorithm.h.

168 { m_type = type;} //BH, TODO: move to proper place

Algorithm::type

const std::string & type() const override

The type of the algorithm object.

Definition: Algorithm.h:167

std::string m_type

Algorithm's type.

Definition: Algorithm.h:849

void Algorithm::setType ( const std::string & type )

inlineoverride

Definition at line 168 of file Algorithm.h.

168 { m_type = type;} //BH, TODO: move to proper place

Algorithm::type

const std::string & type() const override

The type of the algorithm object.

Definition: Algorithm.h:167

std::string m_type

Algorithm's type.

Definition: Algorithm.h:849

StatusCode Algorithm::start ( )

inlineoverride

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

Definition at line 182 of file Algorithm.h.

182 { return StatusCode::SUCCESS ; }

Definition: StatusCode.h:30

StatusCode Algorithm::start ( )

inlineoverride

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

Definition at line 182 of file Algorithm.h.

182 { return StatusCode::SUCCESS ; }

Definition: StatusCode.h:30

StatusCode Algorithm::stop ( )

inlineoverride

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

Definition at line 184 of file Algorithm.h.

184 { return StatusCode::SUCCESS ; }

Definition: StatusCode.h:30

StatusCode Algorithm::stop ( )

inlineoverride

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

Definition at line 184 of file Algorithm.h.

184 { return StatusCode::SUCCESS ; }

Algorithm::serviceLocator

Definition: StatusCode.h:30

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

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

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

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

Definition at line 956 of file Algorithm.cpp.

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

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

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

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

Definition at line 960 of file Algorithm.cpp.

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

inline

shortcut for method serviceLocator

Definition at line 350 of file Algorithm.h.

350 { return serviceLocator() ; }

SmartIF< ISvcLocator > & serviceLocator() const

The standard service locator.

Definition: Algorithm.cpp:1045

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

inline

shortcut for method serviceLocator

Definition at line 350 of file Algorithm.h.

350 { return serviceLocator() ; }

Algorithm::serviceLocator

SmartIF< ISvcLocator > & serviceLocator() const

The standard service locator.

Definition: Algorithm.cpp:1045

StatusCode Algorithm::sysBeginRun ( )

override

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.

Definition at line 510 of file Algorithm.cpp.

StatusCode Algorithm::sysBeginRun ( )

override

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.

StatusCode Algorithm::sysEndRun ( )

override

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.

StatusCode Algorithm::sysEndRun ( )

override

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.

Definition at line 581 of file Algorithm.cpp.

StatusCode Algorithm::sysExecute ( )

override

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.

Definition at line 652 of file Algorithm.cpp.

StatusCode Algorithm::sysExecute ( )

override

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.

StatusCode Algorithm::sysFinalize ( )

override

System finalization.

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

StatusCode Algorithm::sysFinalize ( )

override

System finalization.

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

Definition at line 817 of file Algorithm.cpp.

StatusCode Algorithm::sysInitialize ( )

override

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.

Definition at line 101 of file Algorithm.cpp.

                                           {
   return GaudiPython::call_python_method ( m_self , "endRun" ) ; }
 

StatusCode Algorithm::sysInitialize ( )

override

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.

StatusCode Algorithm::sysReinitialize ( )

override

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.

Definition at line 354 of file Algorithm.cpp.

StatusCode Algorithm::sysReinitialize ( )

override

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.

StatusCode Algorithm::sysRestart ( )

override

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.

StatusCode Algorithm::sysRestart ( )

override

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.

Definition at line 432 of file Algorithm.cpp.

StatusCode Algorithm::sysStart ( )

override

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.

StatusCode Algorithm::sysStart ( )

override

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.

Definition at line 282 of file Algorithm.cpp.

StatusCode Algorithm::sysStop ( )

override

System stop.

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

Definition at line 761 of file Algorithm.cpp.

StatusCode Algorithm::sysStop ( )

override

System stop.

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

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

inlineoverride

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

Definition at line 194 of file Algorithm.h.

194 { return m_targetState; }

Algorithm::m_targetState

Gaudi::StateMachine::State m_targetState

Algorithm has been initialized flag.

Definition: Algorithm.h:905

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

inlineoverride

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

Definition at line 194 of file Algorithm.h.

194 { return m_targetState; }

Algorithm::m_targetState

Gaudi::StateMachine::State m_targetState

Algorithm has been initialized flag.

Definition: Algorithm.h:905

StatusCode Algorithm::terminate ( )

inlineoverride

Dummy implementation of IStateful::terminate() method.

Definition at line 177 of file Algorithm.h.

177 { return StatusCode::SUCCESS ; }

Definition: StatusCode.h:30

StatusCode Algorithm::terminate ( )

inlineoverride

Dummy implementation of IStateful::terminate() method.

Definition at line 177 of file Algorithm.h.

177 { return StatusCode::SUCCESS ; }

Definition: StatusCode.h:30

SmartIF<ITimelineSvc>& Algorithm::timelineSvc ( ) const

const std::vector< IAlgTool * > & Algorithm::tools ( ) const

Definition at line 1156 of file Algorithm.cpp.

const std::vector<IAlgTool *>& Algorithm::tools ( ) const

std::vector< IAlgTool * > & Algorithm::tools ( )

protected

Definition at line 1163 of file Algorithm.cpp.

std::vector<IAlgTool *>& Algorithm::tools ( )

protected

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

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

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

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

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

inlineoverride

The type of the algorithm object.

Definition at line 167 of file Algorithm.h.

167 { return m_type;}

std::string m_type

Algorithm's type.

Definition: Algorithm.h:849

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

inlineoverride

The type of the algorithm object.

Definition at line 167 of file Algorithm.h.

167 { return m_type;}