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

#include <GaudiKernel/AlgTool.h>

Inheritance diagram for AlgTool:

Collaboration diagram for AlgTool:

Public Types
typedef Gaudi::PluginService::Factory< IAlgTool , const std::string &, const std::string &, const IInterface >	Factory

Public Types inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >
using	base_class = CommonMessaging

Public Member Functions
StatusCode	queryInterface (const InterfaceID &riid, void **ppvUnknown) override
	Query for a given interface. More...

const std::string &	name () const override
	Retrieve full identifying name of the concrete tool object. More...

const std::string &	type () const override
	Retrieve type (concrete class) of the sub-algtool. More...

const IInterface *	parent () const override
	Retrieve parent of the sub-algtool. More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

StatusCode	reinitialize () override

StatusCode	restart () override

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

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

StatusCode	sysInitialize () override
	Initialize AlgTool. More...

StatusCode	sysStart () override
	Start AlgTool. More...

StatusCode	sysStop () override
	Stop AlgTool. More...

StatusCode	sysFinalize () override
	Finalize AlgTool. More...

StatusCode	sysReinitialize () override
	Initialize AlgTool. More...

StatusCode	sysRestart () override
	Start AlgTool. More...

StatusCode	setProperty (const Property &p) override
	Default implementations for IProperty interface. More...

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

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

StatusCode	getProperty (Property *p) const override

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

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

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

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

PropertyMgr *	getPropertyMgr () const

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

	AlgTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor. More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...

ISvcLocator *	svcLoc () const
	shortcut for the method service locator More...

IDataProviderSvc *	evtSvc () const
	accessor to event service service More...

IToolSvc *	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present. More...

StatusCode	setProperties ()
	Method for setting declared properties to the values specified in the jobOptions via the job option service. More...

template<class T >
StatusCode	service (const std::string &name, T *&svc, 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 &type, const std::string &name, T *&svc) const
	Access a service by name, 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...

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

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...

template<class T >
Property *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none") const

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)

template<class T >
Property *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none") const

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override

virtual const DataObjIDColl &	extraInputDeps () const override

virtual const DataObjIDColl &	extraOutputDeps () const override

virtual void	acceptDHVisitor (IDataHandleVisitor *) const override

DataObjIDColl	inputDataObjs () const

DataObjIDColl	outputDataObjs () const

void	commitHandles () override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used public tool. More...

template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used private tool. More...

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

IAuditorSvc *	auditorSvc () const
	Access the auditor service. More...

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...

	~AlgTool () override

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...

MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Protected Member Functions
template<typename I >
void	declareInterface (I *i)

virtual void	declareInput (Gaudi::DataHandle *im) override

virtual void	declareOutput (Gaudi::DataHandle *im) override

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

Protected Member Functions inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes
std::unique_ptr< IDataHandleVisitor >	m_updateDataHandles
	Hook for for derived classes to provide a custom visitor for data handles. More...

SmartIF< PropertyMgr >	m_propertyMgr
	Property Manager. More...

Private Types
typedef std::list< std::pair< InterfaceID, void * > >	InterfaceList

Private Member Functions
void	initToolHandles () const

StatusCode	service_i (const std::string &algName, bool createIf, const InterfaceID &iid, void **ppSvc) const
	flag indicating whether ToolHandle tools have been added to m_tools More...

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

Private Attributes
std::vector< Gaudi::DataHandle * >	m_inputHandles

std::vector< Gaudi::DataHandle * >	m_outputHandles

DataObjIDColl	m_inputDataObjs

DataObjIDColl	m_outputDataObjs

DataObjIDColl	m_extInputDataObjs

DataObjIDColl	m_extOutputDataObjs

IntegerProperty	m_outputLevel = MSG::NIL
	AlgTool output level. More...

std::string	m_type
	AlgTool type (concrete class name) More...

const std::string	m_name
	AlgTool full name. More...

const IInterface *	m_parent = nullptr
	AlgTool parent. More...

SmartIF< ISvcLocator >	m_svcLocator
	Pointer to Service Locator service. More...

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

SmartIF< IToolSvc >	m_ptoolSvc
	Tool service. More...

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

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

InterfaceList	m_interfaceList
	Interface list. More...

std::string	m_threadID
	Thread Id for Alg Tool. More...

std::vector< IAlgTool * >	m_tools

std::vector< BaseToolHandle * >	m_toolHandles

std::vector< GaudiHandleArrayBase * >	m_toolHandleArrays

bool	m_toolHandlesInit = false

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

BooleanProperty	m_auditInit = false

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

bool	m_auditorStart = false
	flag for auditors in "start()" More...

bool	m_auditorStop = false
	flag for auditors in "stop()" More...

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

bool	m_auditorReinitialize = false
	flag for auditors in "reinitialize()" More...

bool	m_auditorRestart = false
	flag for auditors in "restart()" More...

Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::CONFIGURED
	state of the Tool More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::CONFIGURED
	state of the Tool More...

Detailed Description

Base class from which all the concrete tool classes should be derived.

Specific methods for doing something useful should be implemented in the concrete tools. Sub-types of this class could implement an additional interface for behavior common to sets of concrete tools (for example vertexers).

Author: Gloria Corti; Pere Mato

Definition at line 45 of file AlgTool.h.

Member Typedef Documentation

typedef Gaudi::PluginService::Factory<IAlgTool*, const std::string&, const std::string&, const IInterface*> AlgTool::Factory

Definition at line 54 of file AlgTool.h.

typedef std::list<std::pair<InterfaceID,void*> > AlgTool::InterfaceList

private

Definition at line 479 of file AlgTool.h.

Constructor & Destructor Documentation

AlgTool::AlgTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Standard Constructor.

Parameters

type	the concrete class of the sub-algtool
name	the full name of the concrete sub-algtool
parent	the parent of the concrete sub-algtool

Definition at line 193 of file AlgTool.cpp.

   : m_type          ( type )
   , m_name          ( name )
   , m_parent        ( parent )
   , m_propertyMgr   ( new PropertyMgr() )
 {
   addRef(); // Initial count set to 1
 
   declareProperty( "MonitorService", m_monitorSvcName = "MonitorSvc" );
 
   { // get the "OutputLevel" property from parent
     const Property* _p = Gaudi::Utils::getProperty ( parent , "OutputLevel") ;
     if ( _p ) { m_outputLevel.assign( *_p ) ; }
     declareProperty ( "OutputLevel"     , m_outputLevel ) ;
      m_outputLevel.declareUpdateHandler([this](Property&) { this->updateMsgStreamOutputLevel(this->m_outputLevel) ; } );
   }
 
   IInterface* _p = const_cast<IInterface*> ( parent ) ;
 
   if      ( Algorithm* _alg = dynamic_cast<Algorithm*> ( _p ) )
   {
     m_svcLocator  = _alg -> serviceLocator  () ;
     m_threadID    = getGaudiThreadIDfromName ( _alg -> name() ) ;
   }
   else if ( Service*   _svc = dynamic_cast<Service*>  ( _p ) )
   {
     m_svcLocator  = _svc -> serviceLocator () ;
     m_threadID    = getGaudiThreadIDfromName ( _svc -> name() ) ;
   }
   else if ( AlgTool*   _too = dynamic_cast<AlgTool*>  ( _p ) )
   {
     m_svcLocator  = _too -> serviceLocator ();
     m_threadID    = getGaudiThreadIDfromName ( _too ->m_threadID ) ;
   }
   else if ( Auditor*   _aud = dynamic_cast<Auditor*>  ( _p ) )
   {
     m_svcLocator  = _aud -> serviceLocator() ;
     m_threadID    = getGaudiThreadIDfromName ( _aud -> name() )    ;
   }
   else
   {
     throw GaudiException
       ( "Failure to create tool '"
         + type + "/" + name + "': illegal parent type '"
         + System::typeinfoName(typeid(*_p)) + "'", "AlgTool", 0 );
   }
 
 
   { // audit tools
     auto appMgr = m_svcLocator->service<IProperty>("ApplicationMgr");
     if ( !appMgr ) {
       throw GaudiException("Could not locate ApplicationMgr","AlgTool",0);
     }
     const Property* p = Gaudi::Utils::getProperty( appMgr , "AuditTools");
     if ( p ) { m_auditInit.assign ( *p ) ; }
     declareProperty ( "AuditTools", m_auditInit );
     bool audit = m_auditInit.value();
     // Declare common AlgTool properties with their defaults
     declareProperty ( "AuditInitialize" , m_auditorInitialize = audit ) ;
     declareProperty ( "AuditStart"      , m_auditorStart      = audit ) ;
     declareProperty ( "AuditStop"       , m_auditorStop       = audit ) ;
     declareProperty ( "AuditFinalize"   , m_auditorFinalize   = audit ) ;
   }
 
   //declare Extra input and output properties
   declareProperty( "ExtraInputs",  m_extInputDataObjs);
   declareProperty( "ExtraOutputs", m_extOutputDataObjs);
 
 
   // check thread ID and try if tool name indicates thread ID
   if ( m_threadID.empty() )
   { m_threadID = getGaudiThreadIDfromName ( AlgTool::name() ) ; }
 }

AlgTool::~AlgTool ( )

override

Definition at line 453 of file AlgTool.cpp.

 {
   if( m_pMonitorSvc ) { m_pMonitorSvc->undeclareAll(this); }
 }

Member Function Documentation

void AlgTool::acceptDHVisitor ( IDataHandleVisitor * vis ) const

overridevirtual

Definition at line 566 of file AlgTool.cpp.

                                                      {
   //-----------------------------------------------------------------------------
   vis->visit(this);
 
   for (auto tool : tools()) {
     AlgTool *at = dynamic_cast<AlgTool*>(tool);
     vis->visit(at);
   }
 
 }

IAuditorSvc * AlgTool::auditorSvc ( ) const

Access the auditor service.

Definition at line 553 of file AlgTool.cpp.

                                        {
 //---------------------------------------------------------------------------
   if ( !m_pAuditorSvc ) {
     m_pAuditorSvc = service( "AuditorSvc", true );
     if( !m_pAuditorSvc ) {
       throw GaudiException("Service [AuditorSvc] not found", name(), StatusCode::FAILURE);
     }
   }
   return m_pAuditorSvc.get();
 }

void AlgTool::commitHandles ( )

override

Definition at line 579 of file AlgTool.cpp.

                        {
   //-----------------------------------------------------------------------------
 
   for (auto h : m_outputHandles) {
     h->commit();
   }
 
   for (auto t : m_tools) {
     AlgTool* at = dynamic_cast<AlgTool*>(t);
     if (at != 0) at->commitHandles();
   }
 
 }

StatusCode AlgTool::configure ( )

inlineoverride

Definition at line 70 of file AlgTool.h.

70 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

Definition: StatusCode.h:30

template<class T >

void AlgTool::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 450 of file AlgTool.h.

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

void AlgTool::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 465 of file AlgTool.h.

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

virtual void AlgTool::declareInput ( Gaudi::DataHandle * im )

inlineoverrideprotectedvirtual

Definition at line 299 of file AlgTool.h.

                                                           {
     m_inputHandles.push_back(im);
   }

template<typename I >

void AlgTool::declareInterface ( I * i )

inlineprotected

Definition at line 215 of file AlgTool.h.

215 { m_interfaceList.emplace_back( I::interfaceID(), i ); }

AlgTool::m_interfaceList

InterfaceList m_interfaceList

Interface list.

Definition: AlgTool.h:492

ana.i

list i

Definition: ana.py:128

std::list::emplace_back

T emplace_back(T...args)

virtual void AlgTool::declareOutput ( Gaudi::DataHandle * im )

inlineoverrideprotectedvirtual

Definition at line 303 of file AlgTool.h.

                                                            {
     m_outputHandles.push_back(im);
         }

template<class T >

StatusCode AlgTool::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 391 of file AlgTool.h.

                                                         {
 
         if (toolTypeAndName == "")
       toolTypeAndName = handle.typeAndName();
 
         StatusCode sc = handle.initialize(toolTypeAndName, this, createIf);
         if (UNLIKELY(!sc)) {
               throw GaudiException{"Cannot create handle for private tool " + toolTypeAndName,
                                    name(), sc};
         }
 
         m_toolHandles.push_back(&handle);
 
         return sc;
     }

template<class T >

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

inline

Declare the named property.

MyTool ( const std::string& type   ,
         const std::string& name   ,
         const IInterface*  parent )
   : AlgTool  ( type , 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( &MyTool::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 249 of file AlgTool.h.

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

template<class T >

Property* AlgTool::declareProperty	(	const std::string &	name,
		ToolHandle< T > &	hndl,
		const std::string &	doc = `"none"`
	)		const

inline

Definition at line 266 of file AlgTool.h.

                                                                     {
     
     AlgTool* a = const_cast<AlgTool*>(this);
     a->declareTool(hndl).ignore();
     
     return m_propertyMgr->declareProperty(name, hndl, doc);
     
   }

template<class T >

Property* AlgTool::declareProperty	(	const std::string &	name,
		ToolHandleArray< T > &	hndlArr,
		const std::string &	doc = `"none"`
	)		const

inline

Definition at line 291 of file AlgTool.h.

                                                                     {
     m_toolHandleArrays.push_back( &hndlArr );    
     return m_propertyMgr->declareProperty(name, hndlArr, doc);
   }

template<class T >

StatusCode AlgTool::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 365 of file AlgTool.h.

                                                        {
 
         if (toolTypeAndName == "")
       toolTypeAndName = handle.typeAndName();
 
         StatusCode sc = handle.initialize(toolTypeAndName, 0, createIf);
         if (UNLIKELY(!sc)) {
               throw GaudiException{"Cannot create handle for public tool " + toolTypeAndName,
                                    name(), sc};
         }
 
         m_toolHandles.push_back(&handle);
 
         return sc;
     }

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

inline

Declare remote named properties.

Definition at line 257 of file AlgTool.h.

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

template<class T >

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

inline

Definition at line 278 of file AlgTool.h.

                                                  {
     if (handle.isPublic()) {
       return declarePublicTool(handle, toolTypeAndName, createIf);
     } else {
       return declarePrivateTool(handle, toolTypeAndName, createIf);
     }
   }

void AlgTool::deregisterTool ( IAlgTool * tool ) const

inline

Definition at line 345 of file AlgTool.h.

                                                {
         auto it = std::find(m_tools.begin(), m_tools.end(), tool);
         if (it != m_tools.end()) {
                 if (UNLIKELY(msgLevel(MSG::DEBUG)))
               debug() << "De-Registering tool " << tool->name() << endmsg;
             m_tools.erase(it);
         } else {
                 if (UNLIKELY(msgLevel(MSG::DEBUG)))
               debug() << "Could not de-register tool " << tool->name() << endmsg;
         }
     }

IDataProviderSvc * AlgTool::evtSvc ( ) const

accessor to event service service

Returns: pointer to detector service

Definition at line 95 of file AlgTool.cpp.

 {
   if ( !m_evtSvc ) {
     m_evtSvc = service("EventDataSvc", true);
     if ( !m_evtSvc ) {
       throw GaudiException("Service [EventDataSvc] not found", name(), StatusCode::FAILURE);
     }
   }
   return m_evtSvc.get();
 }

virtual const DataObjIDColl& AlgTool::extraInputDeps ( ) const

inlineoverridevirtual

Definition at line 313 of file AlgTool.h.

                                                                {
     return m_extInputDataObjs;
   }

virtual const DataObjIDColl& AlgTool::extraOutputDeps ( ) const

inlineoverridevirtual

Definition at line 316 of file AlgTool.h.

                                                                 {
     return m_extOutputDataObjs;
     }

StatusCode AlgTool::finalize ( )

override

Definition at line 360 of file AlgTool.cpp.

 {
   // For the time being there is nothing to be done here.
   return StatusCode::SUCCESS;
 }

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

inlineoverride

Definition at line 78 of file AlgTool.h.

78 { return m_state; }

AlgTool::m_state

Gaudi::StateMachine::State m_state

state of the Tool

Definition: AlgTool.h:521

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

override

Definition at line 160 of file AlgTool.cpp.

 {
   return m_propertyMgr->getProperties();
 }

StatusCode AlgTool::getProperty ( Property * p ) const

override

Definition at line 140 of file AlgTool.cpp.

 {
   return m_propertyMgr->getProperty(p);
 }

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

override

Definition at line 147 of file AlgTool.cpp.

 {
   return m_propertyMgr->getProperty(n);
 }

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

override

Definition at line 153 of file AlgTool.cpp.

 {
   return m_propertyMgr->getProperty(n,v);
 }

PropertyMgr* AlgTool::getPropertyMgr ( ) const

inline

Definition at line 109 of file AlgTool.h.

109 { return m_propertyMgr; }

AlgTool::m_propertyMgr

SmartIF< PropertyMgr > m_propertyMgr

Property Manager.

Definition: AlgTool.h:490

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

override

Definition at line 166 of file AlgTool.cpp.

                                                      {
   return m_propertyMgr->hasProperty(name);
 }

StatusCode AlgTool::initialize ( )

override

Definition at line 290 of file AlgTool.cpp.

 {
   // For the time being there is nothing to be done here.
   // Setting the properties is done by the ToolSvc calling setProperties()
   // explicitly.
   return StatusCode::SUCCESS;
 }

void AlgTool::initToolHandles ( ) const

private

Definition at line 460 of file AlgTool.cpp.

                                    {
 
   IAlgTool* tool(0);
   for (auto thArr : m_toolHandleArrays) {
     if (! thArr->retrieved()) {
       if (UNLIKELY(msgLevel(MSG::DEBUG)))
         debug() << "ToolHandleArray " << thArr->propertyName()
                 << " not used: not registering any of its Tools" << endmsg;
     } else {
       if (UNLIKELY(msgLevel(MSG::DEBUG)))
         debug() << "Registering all Tools in ToolHandleArray " 
                 << thArr->propertyName() ;
       for (auto th_name : thArr->typesAndNames()) {
         if (UNLIKELY(msgLevel(MSG::DEBUG)))
           debug() << std::endl << "    + " << th_name;
         if (toolSvc()->retrieveTool(th_name, tool, this).isSuccess()) {
           if (UNLIKELY(msgLevel(MSG::DEBUG)))
             debug() << " (private)";
           m_tools.push_back(tool);
         } else if (toolSvc()->retrieveTool(th_name, tool, 0).isSuccess()) {
           if (UNLIKELY(msgLevel(MSG::DEBUG)))
             debug() << " (public)";
           m_tools.push_back(tool);
         } else {
           if (UNLIKELY(msgLevel(MSG::DEBUG)))
             debug() << " - ERROR" << endmsg;
           warning() <<  "Error retrieving Tool " << th_name 
                     << " in ToolHandleArray" << thArr->propertyName()
                     << ". Not registered" << endmsg;
         }
       }
       if (UNLIKELY(msgLevel(MSG::DEBUG))) debug() << endmsg;
     }
   }
 
   for(auto th : m_toolHandles){
     tool = th->get();
     if(tool){
       m_tools.push_back(tool);
       if (UNLIKELY(msgLevel(MSG::DEBUG)))
         debug() << "Adding "
         << (th->isPublic() ? "Public" : "Private" )
         << " ToolHandle tool " << tool->name()
         << " (" << tool->type() << ")" << endmsg;
     } else {
       if (UNLIKELY(msgLevel(MSG::DEBUG)))
         debug() << "ToolHandle " << th->typeAndName() << " not used" << endmsg;
     }
   }
   m_toolHandlesInit = true;
 }

DataObjIDColl AlgTool::inputDataObjs ( ) const

inline

Definition at line 323 of file AlgTool.h.

323 { return m_inputDataObjs; }

AlgTool::m_inputDataObjs

DataObjIDColl m_inputDataObjs

Definition: AlgTool.h:331

virtual std::vector<Gaudi::DataHandle*> AlgTool::inputHandles ( ) const

inlineoverridevirtual

Definition at line 308 of file AlgTool.h.

308 {

309 return m_inputHandles; }

AlgTool::m_inputHandles

std::vector< Gaudi::DataHandle * > m_inputHandles

Definition: AlgTool.h:330

IMonitorSvc* AlgTool::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 437 of file AlgTool.h.

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

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

override

Retrieve full identifying name of the concrete tool object.

Definition at line 65 of file AlgTool.cpp.

 {
   return m_name;
 }

DataObjIDColl AlgTool::outputDataObjs ( ) const

inline

Definition at line 324 of file AlgTool.h.

324 { return m_outputDataObjs; }

AlgTool::m_outputDataObjs

DataObjIDColl m_outputDataObjs

Definition: AlgTool.h:331

virtual std::vector<Gaudi::DataHandle*> AlgTool::outputHandles ( ) const

inlineoverridevirtual

Definition at line 310 of file AlgTool.h.

310 {

311 return m_outputHandles; }

AlgTool::m_outputHandles

std::vector< Gaudi::DataHandle * > m_outputHandles

Definition: AlgTool.h:330

const IInterface * AlgTool::parent ( ) const

override

Retrieve parent of the sub-algtool.

Definition at line 79 of file AlgTool.cpp.

 {
   return m_parent;
 }

StatusCode AlgTool::queryInterface	(	const InterfaceID &	riid,
		void **	ppvUnknown
	)

override

Query for a given interface.

Definition at line 45 of file AlgTool.cpp.

 {
   if ( !ppvi ) { return StatusCode::FAILURE ; } // RETURN
   StatusCode sc = base_class::queryInterface(riid,ppvi);
   if (sc.isSuccess()) return sc;
   auto i = std::find_if( std::begin(m_interfaceList), std::end(m_interfaceList),
                          [&](const std::pair<InterfaceID,void*>& item) {
                              return item.first.versionMatch(riid);
   } );
   if ( i == std::end(m_interfaceList) ) {
     *ppvi = nullptr ;
     return NO_INTERFACE ;  // RETURN
   }
   *ppvi = i->second ;
   addRef() ;
   return SUCCESS ;     // RETURN
 }

void AlgTool::registerTool ( IAlgTool * tool ) const

inline

Definition at line 339 of file AlgTool.h.

                                              {
         if (UNLIKELY(msgLevel(MSG::DEBUG)))
           debug() << "Registering tool " << tool->name() << endmsg;
         m_tools.push_back(tool);
     }

StatusCode AlgTool::reinitialize ( )

override

Definition at line 390 of file AlgTool.cpp.

 {
   /* @TODO
    * MCl 2008-10-23: the implementation of reinitialize as finalize+initialize
    *                 is causing too many problems
    *
   // Default implementation is finalize+initialize
   StatusCode sc = finalize();
   if (sc.isFailure()) {
     error() << "reinitialize(): cannot be finalized" << endmsg;
     return sc;
   }
   sc = initialize();
   if (sc.isFailure()) {
     error() << "reinitialize(): cannot be initialized" << endmsg;
     return sc;
   }
   */
   return StatusCode::SUCCESS;
 }

StatusCode AlgTool::restart ( )

override

Definition at line 435 of file AlgTool.cpp.

 {
   // Default implementation is stop+start
   StatusCode sc = stop();
   if (sc.isFailure()) {
     error() << "restart(): cannot be stopped" << endmsg;
     return sc;
   }
   sc = start();
   if (sc.isFailure()) {
     error() << "restart(): cannot be started" << endmsg;
     return sc;
   }
   return StatusCode::SUCCESS;
 }

template<class T >

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

inline

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

Definition at line 195 of file AlgTool.h.

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

template<class T >

StatusCode AlgTool::service	(	const std::string &	type,
		const std::string &	name,
		T *&	svc
	)		const

inline

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

Definition at line 202 of file AlgTool.h.

                                                                                    {
     return service_i(type, name, T::interfaceID(), (void**)&svc);
   }

SmartIF< IService > AlgTool::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 547 of file AlgTool.cpp.

                                                                                                      {
   const ServiceLocatorHelper helper(*serviceLocator(), *this);
   return helper.service(name, quiet, createIf);
 }

template<typename T >

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

inline

Definition at line 210 of file AlgTool.h.

211 { return SmartIF<T>( service(name,createIf,quiet) ); }

SmartIF

Small smart pointer class with automatic reference counting for IInterface.

Definition: IConverter.h:14

AlgTool::service

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

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

Definition: AlgTool.h:195

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

private

flag indicating whether ToolHandle tools have been added to m_tools

implementation of service method

Definition at line 529 of file AlgTool.cpp.

                                        {
   const ServiceLocatorHelper helper(*serviceLocator(), *this);
   return helper.getService(svcName, createIf, iid, ppSvc);
 }

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

private

Definition at line 539 of file AlgTool.cpp.

                                        {
   const ServiceLocatorHelper helper(*serviceLocator(), *this);
   return  helper.createService(svcType, svcName, iid, ppSvc);
 }

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

override

Retrieve pointer to service locator.

Definition at line 86 of file AlgTool.cpp.

 {
   return m_svcLocator;
 }

StatusCode AlgTool::setProperties ( )

Method for setting declared properties to the values specified in the jobOptions via the job option service.

This method is called by the ToolSvc after creating the concrete tool, before passing it to the requesting parent and does not need to be called explicitly.

Definition at line 171 of file AlgTool.cpp.

 {
   if( !m_svcLocator ) return StatusCode::FAILURE;
   auto jos = m_svcLocator->service<IJobOptionsSvc>("JobOptionsSvc");
   if( !jos )  return StatusCode::FAILURE;
 
   // set first generic Properties
   StatusCode sc = jos->setMyProperties( getGaudiThreadGenericName(name()), this );
   if( sc.isFailure() ) return StatusCode::FAILURE;
 
   // set specific Properties
   if (isGaudiThreaded(name())) {
     if(jos->setMyProperties( name(), this ).isFailure()) {
       return StatusCode::FAILURE;
     }
   }
   updateMsgStreamOutputLevel( m_outputLevel );
   return StatusCode::SUCCESS;
 }

StatusCode AlgTool::setProperty ( const Property & p )

override

Default implementations for IProperty interface.

Definition at line 119 of file AlgTool.cpp.

 {
   return m_propertyMgr->setProperty(p);
 }

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

override

Definition at line 126 of file AlgTool.cpp.

 {
   return m_propertyMgr->setProperty(s);
 }

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

override

Definition at line 133 of file AlgTool.cpp.

 {
   return m_propertyMgr->setProperty(n,v);
 }

template<class TYPE >

StatusCode AlgTool::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 155 of file AlgTool.h.

157 { 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

SmartIF::get

TYPE * get() const

Get interface pointer.

Definition: SmartIF.h:76

AlgTool::m_propertyMgr

SmartIF< PropertyMgr > m_propertyMgr

Property Manager.

Definition: AlgTool.h:490

dump_component_properties.value

list value

Definition: dump_component_properties.py:12

AlgTool::name

const std::string & name() const override

Retrieve full identifying name of the concrete tool object.

Definition: AlgTool.cpp:65

StatusCode AlgTool::start ( )

override

Definition at line 315 of file AlgTool.cpp.

 {
   // For the time being there is nothing to be done here.
   return StatusCode::SUCCESS;
 }

StatusCode AlgTool::stop ( )

override

Definition at line 338 of file AlgTool.cpp.

 {
   // For the time being there is nothing to be done here.
   return StatusCode::SUCCESS;
 }

ISvcLocator* AlgTool::svcLoc ( ) const

inline

shortcut for the method service locator

Definition at line 173 of file AlgTool.h.

173 { return serviceLocator() ; }

AlgTool::serviceLocator

SmartIF< ISvcLocator > & serviceLocator() const override

Retrieve pointer to service locator.

Definition: AlgTool.cpp:86

StatusCode AlgTool::sysFinalize ( )

override

Finalize AlgTool.

Definition at line 346 of file AlgTool.cpp.

                                 {
 //-----------------------------------------------------------------------------
   return attempt( *this, "sysFinalize", [&]() {
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::FINALIZE, m_state);
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       m_auditorFinalize ? auditorSvc() : nullptr,
                                       IAuditor::Finalize);
     StatusCode sc = finalize();
     if (sc.isSuccess()) m_state = m_targetState;
     return sc;
   } );
 }

StatusCode AlgTool::sysInitialize ( )

override

Initialize AlgTool.

Definition at line 271 of file AlgTool.cpp.

                                   {
 //-----------------------------------------------------------------------------
   return attempt( *this, "sysInitialize", [&]() {
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::INITIALIZE, m_state);
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       m_auditorInitialize ? auditorSvc() : nullptr,
                                       IAuditor::Initialize);
     StatusCode sc = initialize();
     if (!sc) return sc;
 
     m_state = m_targetState;
     if (m_updateDataHandles)
         acceptDHVisitor(m_updateDataHandles.get());
 
     return sc;
   } );
 }

StatusCode AlgTool::sysReinitialize ( )

override

Initialize AlgTool.

Definition at line 368 of file AlgTool.cpp.

                                     {
 //-----------------------------------------------------------------------------
 
   // Check that the current status is the correct one.
   if ( Gaudi::StateMachine::INITIALIZED != FSMState() ) {
     error()
         << "sysReinitialize(): cannot reinitialize tool not initialized"
         << endmsg;
     return StatusCode::FAILURE;
   }
 
   return attempt(*this, "SysReinitialize()", [&]() {
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       m_auditorReinitialize ? auditorSvc() : nullptr,
                                       IAuditor::ReInitialize);
     return reinitialize();
   } );
 
 }

StatusCode AlgTool::sysRestart ( )

override

Start AlgTool.

Definition at line 413 of file AlgTool.cpp.

                                {
 //-----------------------------------------------------------------------------
 
   // Check that the current status is the correct one.
   if ( Gaudi::StateMachine::RUNNING != FSMState() ) {
     error()
         << "sysRestart(): cannot reinitialize tool not started"
         << endmsg;
     return StatusCode::FAILURE;
   }
 
   return attempt(*this, "sysRestart", [&]()  {
     m_targetState = Gaudi::StateMachine::ChangeState(Gaudi::StateMachine::START,m_state);
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       m_auditorRestart ? auditorSvc() : nullptr,
                                       IAuditor::ReStart);
     return restart();
   } );
 }

StatusCode AlgTool::sysStart ( )

override

Start AlgTool.

Definition at line 300 of file AlgTool.cpp.

                              {
 //-----------------------------------------------------------------------------
   return attempt( *this, "sysInitialize", [&]() {
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::START, m_state);
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       m_auditorStart ? auditorSvc() : nullptr,
                                       IAuditor::Start);
     StatusCode sc = start();
     if (sc.isSuccess()) m_state = m_targetState;
     return sc;
   } );
 }

StatusCode AlgTool::sysStop ( )

override

Stop AlgTool.

Definition at line 323 of file AlgTool.cpp.

                             {
 //-----------------------------------------------------------------------------
   return attempt( *this, "sysStop", [&]() {
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::STOP, m_state);
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       m_auditorStop ? auditorSvc() : nullptr,
                                       IAuditor::Stop);
     StatusCode sc = stop();
     if (sc.isSuccess()) m_state = m_targetState;
     return sc;
   } );
 }

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

inlineoverride

Definition at line 79 of file AlgTool.h.

79 { return m_targetState; }

AlgTool::m_targetState

Gaudi::StateMachine::State m_targetState

state of the Tool

Definition: AlgTool.h:522

StatusCode AlgTool::terminate ( )

inlineoverride

Definition at line 75 of file AlgTool.h.

75 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

Definition: StatusCode.h:30

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

Definition at line 512 of file AlgTool.cpp.

                                                    {
     if(UNLIKELY(!m_toolHandlesInit))
         initToolHandles();
 
     return m_tools;
 }

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

protected

Definition at line 519 of file AlgTool.cpp.

                                        {
     if(UNLIKELY(!m_toolHandlesInit))
         initToolHandles();
 
     return m_tools;
 }

IToolSvc * AlgTool::toolSvc ( ) const

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

Definition at line 106 of file AlgTool.cpp.

 {
   if ( !m_ptoolSvc ) {
     m_ptoolSvc = service( "ToolSvc", true );
     if( !m_ptoolSvc ) {
       throw GaudiException("Service [ToolSvc] not found", name(), StatusCode::FAILURE);
     }
   }
   return m_ptoolSvc.get();
 }

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

override

Retrieve type (concrete class) of the sub-algtool.

Definition at line 72 of file AlgTool.cpp.

 {
   return m_type;
 }

Member Data Documentation

BooleanProperty AlgTool::m_auditInit = false

private

Definition at line 513 of file AlgTool.h.

bool AlgTool::m_auditorFinalize = false

private

flag for auditors in "finalize()"

Definition at line 517 of file AlgTool.h.

bool AlgTool::m_auditorInitialize = false

private

flag for auditors in "initialize()"

Definition at line 514 of file AlgTool.h.

bool AlgTool::m_auditorReinitialize = false

private

flag for auditors in "reinitialize()"

Definition at line 518 of file AlgTool.h.

bool AlgTool::m_auditorRestart = false

private

flag for auditors in "restart()"

Definition at line 519 of file AlgTool.h.

bool AlgTool::m_auditorStart = false

private

flag for auditors in "start()"

Definition at line 515 of file AlgTool.h.

bool AlgTool::m_auditorStop = false

private

flag for auditors in "stop()"

Definition at line 516 of file AlgTool.h.

SmartIF<IDataProviderSvc> AlgTool::m_evtSvc

mutableprivate

Event data service.

Definition at line 485 of file AlgTool.h.

DataObjIDColl AlgTool::m_extInputDataObjs

private

Definition at line 333 of file AlgTool.h.

DataObjIDColl AlgTool::m_extOutputDataObjs

private

Definition at line 333 of file AlgTool.h.

DataObjIDColl AlgTool::m_inputDataObjs

private

Definition at line 331 of file AlgTool.h.

std::vector<Gaudi::DataHandle*> AlgTool::m_inputHandles

private

Definition at line 330 of file AlgTool.h.

InterfaceList AlgTool::m_interfaceList

private

Interface list.

Definition at line 492 of file AlgTool.h.

std::string AlgTool::m_monitorSvcName

private

Name to use for Monitor Service.

Definition at line 488 of file AlgTool.h.

const std::string AlgTool::m_name

private

AlgTool full name.

Definition at line 482 of file AlgTool.h.

DataObjIDColl AlgTool::m_outputDataObjs

private

Definition at line 331 of file AlgTool.h.

std::vector<Gaudi::DataHandle*> AlgTool::m_outputHandles

private

Definition at line 330 of file AlgTool.h.

IntegerProperty AlgTool::m_outputLevel = MSG::NIL

private

AlgTool output level.

Definition at line 480 of file AlgTool.h.

const IInterface* AlgTool::m_parent = nullptr

private

AlgTool parent.

Definition at line 483 of file AlgTool.h.

SmartIF<IAuditorSvc> AlgTool::m_pAuditorSvc

mutableprivate

Auditor Service.

Definition at line 511 of file AlgTool.h.

SmartIF<IMonitorSvc> AlgTool::m_pMonitorSvc

mutableprivate

Online Monitoring Service.

Definition at line 487 of file AlgTool.h.

SmartIF<PropertyMgr> AlgTool::m_propertyMgr

protected

Property Manager.

Definition at line 490 of file AlgTool.h.

SmartIF<IToolSvc> AlgTool::m_ptoolSvc

mutableprivate

Tool service.

Definition at line 486 of file AlgTool.h.

Gaudi::StateMachine::State AlgTool::m_state = Gaudi::StateMachine::CONFIGURED

private

state of the Tool

Definition at line 521 of file AlgTool.h.

SmartIF<ISvcLocator> AlgTool::m_svcLocator

mutableprivate

Pointer to Service Locator service.

Definition at line 484 of file AlgTool.h.

Gaudi::StateMachine::State AlgTool::m_targetState = Gaudi::StateMachine::CONFIGURED

private

state of the Tool

Definition at line 522 of file AlgTool.h.

std::string AlgTool::m_threadID

private

Thread Id for Alg Tool.

Definition at line 493 of file AlgTool.h.

std::vector<GaudiHandleArrayBase*> AlgTool::m_toolHandleArrays

mutableprivate

Definition at line 498 of file AlgTool.h.

std::vector<BaseToolHandle *> AlgTool::m_toolHandles

mutableprivate

Definition at line 497 of file AlgTool.h.

bool AlgTool::m_toolHandlesInit = false

mutableprivate

Definition at line 499 of file AlgTool.h.

std::vector<IAlgTool *> AlgTool::m_tools

mutableprivate

Definition at line 496 of file AlgTool.h.

std::string AlgTool::m_type

private

AlgTool type (concrete class name)

Definition at line 481 of file AlgTool.h.

std::unique_ptr<IDataHandleVisitor> AlgTool::m_updateDataHandles

protected

Hook for for derived classes to provide a custom visitor for data handles.

Definition at line 416 of file AlgTool.h.

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

GaudiKernel/GaudiKernel/AlgTool.h
GaudiKernel/src/Lib/AlgTool.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation