In This Package:

IChronoStatSvc Class Reference

The IChronoStatSvc is the interface implemented by the ChronoStatService. More...

#include <GaudiKernel/IChronoStatSvc.h>

Inheritance diagram for IChronoStatSvc:

[legend]Collaboration diagram for IChronoStatSvc:[legend]List of all members.


Public Types
	SUCCESS = 1
	Normal successful completion.
	NO_INTERFACE
	Requested interface is not available.
	VERSMISMATCH
	Requested interface version is incompatible.
	LAST_ERROR
	Last error.
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...
typedef std::string	ChronoTag
	the actual type of identifier for Chrono objects
typedef double	ChronoTime
	Type of the delta-time.
	UNKNOWN = 0
	RUNNING
	STOPPED
	USER = 0
	KERNEL
	ELAPSED
enum	ChronoStatus { UNKNOWN = 0, RUNNING, STOPPED }
enum	ChronoType { USER = 0, KERNEL, ELAPSED }
typedef std::string	StatTag
	the actual identificator of Stat
typedef double	StatFlag
	the actual value type used for Stat
Public Member Functions
virtual const InterfaceID &	type () const =0
	Retrieve ID of the Service. Not really used.
virtual StatusCode	sysInitialize ()=0
	Initilize Service.
virtual StatusCode	sysStart ()=0
	Start Service.
virtual StatusCode	sysStop ()=0
	Stop Service.
virtual StatusCode	sysFinalize ()=0
	Finalize Service.
virtual StatusCode	sysReinitialize ()=0
	Re-initialize the Service.
virtual StatusCode	sysRestart ()=0
	Re-start the Service.
virtual StatusCode	configure ()=0
	Configuration (from OFFLINE to CONFIGURED).
virtual StatusCode	initialize ()=0
	Initialization (from CONFIGURED to INITIALIZED).
virtual StatusCode	start ()=0
	Start (from INITIALIZED to RUNNING).
virtual StatusCode	stop ()=0
	Stop (from RUNNING to INITIALIZED).
virtual StatusCode	finalize ()=0
	Finalize (from INITIALIZED to CONFIGURED).
virtual StatusCode	terminate ()=0
	Initialization (from CONFIGURED to OFFLINE).
virtual StatusCode	reinitialize ()=0
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).
virtual StatusCode	restart ()=0
	Initialization (from RUNNING to RUNNING, via INITIALIZED).
virtual Gaudi::StateMachine::State	FSMState () const =0
	Get the current state.
virtual Gaudi::StateMachine::State	targetFSMState () const =0
	When we are in the middle of a transition, get the state where the transition is leading us.
virtual const std::string &	name () const =0
	Retrieve the name of the instance.
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)=0
	Query interfaces of Interface.
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance.
virtual unsigned long	release ()=0
	Release Interface instance.
virtual ChronoEntity *	chronoStart (const ChronoTag &t)=0
	start chrono, tagged by its name
virtual const ChronoEntity *	chronoStop (const ChronoTag &t)=0
	stop chrono, tagged by its name
virtual ChronoTime	chronoDelta (const ChronoTag &t, ChronoType f)=0
	return chrono delta time of last start/stop pair
virtual void	chronoPrint (const ChronoTag &t)=0
	prints (using message service) info about chrono, tagged by its name
virtual ChronoStatus	chronoStatus (const ChronoTag &t)=0
	return the status of named chrono
virtual const ChronoEntity *	chrono (const ChronoTag &t) const =0
	extract the chrono entity for the given tag (name)
virtual void	stat (const StatTag &t, const StatFlag &f)=0
	add statistical information to the entity , tagged by its name
virtual const StatEntity *	stat (const StatTag &t) const =0
	extract the stat entity for the given tag (name)
virtual void	statPrint (const StatTag &t)=0
	prints (using message service) info about statistical entity, tagged by its name
Static Public Member Functions
static const InterfaceID &	interfaceID ()
	unique interface identifier
Protected Member Functions
virtual	~IChronoStatSvc ()
	virtual and desctructor
virtual void	setServiceManager (ISvcManager *)=0

Detailed Description

The IChronoStatSvc is the interface implemented by the ChronoStatService.

This interface is used by any algorithm or services wanting to study its own performance and CPU consumption and some statistical computation

See also:: IChronoSvc
IStatSvc

Author:: Vanya BELYAEV ibelyaev@physics.syr.edu (inspired by Mauro VILLA's codes used within ARTE framework )

Date:: December 1, 1999
2007-07-08

Definition at line 36 of file IChronoStatSvc.h.

Member Typedef Documentation

typedef std::string IChronoSvc::ChronoTag [inherited]

the actual type of identifier for Chrono objects

Definition at line 38 of file IChronoSvc.h.

typedef double IChronoSvc::ChronoTime [inherited]

Type of the delta-time.

Definition at line 41 of file IChronoSvc.h.

typedef std::string IStatSvc::StatTag [inherited]

the actual identificator of Stat

Definition at line 31 of file IStatSvc.h.

typedef double IStatSvc::StatFlag [inherited]

the actual value type used for Stat

Definition at line 33 of file IStatSvc.h.

Member Enumeration Documentation

enum IInterface::Status [inherited]

Return status.

Enumerator:

SUCCESS	Normal successful completion.
NO_INTERFACE	Requested interface is not available.
VERSMISMATCH	Requested interface version is incompatible.
LAST_ERROR	Last error.

Reimplemented in IConversionSvc, IConverter, and IDataProviderSvc.

Definition at line 113 of file IInterface.h.

00113                 {
00115     SUCCESS = 1,
00117     NO_INTERFACE,
00119     VERSMISMATCH,
00121     LAST_ERROR
00122   };

enum IChronoSvc::ChronoStatus [inherited]

Enumerator:

UNKNOWN
RUNNING
STOPPED

Definition at line 46 of file IChronoSvc.h.

00047     {
00048       UNKNOWN = 0 ,                       
00049       RUNNING     , 
00050       STOPPED     
00051     };

enum IChronoSvc::ChronoType [inherited]

Enumerator:

USER
KERNEL
ELAPSED

Definition at line 53 of file IChronoSvc.h.

00054     { 
00055       USER = 0 , 
00056       KERNEL   , 
00057       ELAPSED  
00058     } ;

Constructor & Destructor Documentation

virtual IChronoStatSvc::~IChronoStatSvc ( ) [protected, virtual]

virtual and desctructor

Member Function Documentation

static const InterfaceID& IChronoStatSvc::interfaceID ( ) [static]

unique interface identifier

Reimplemented from IChronoSvc.

virtual const InterfaceID& IService::type ( ) const [pure virtual, inherited]

Retrieve ID of the Service. Not really used.

Implemented in Service.

virtual StatusCode IService::sysInitialize ( ) [pure virtual, inherited]

Initilize Service.

Implemented in Service.

virtual StatusCode IService::sysStart ( ) [pure virtual, inherited]

Start Service.

Implemented in Service.

virtual StatusCode IService::sysStop ( ) [pure virtual, inherited]

Stop Service.

Implemented in Service.

virtual StatusCode IService::sysFinalize ( ) [pure virtual, inherited]

Finalize Service.

Implemented in Service.

virtual StatusCode IService::sysReinitialize ( ) [pure virtual, inherited]

Re-initialize the Service.

Implemented in Service.

virtual StatusCode IService::sysRestart ( ) [pure virtual, inherited]

Re-start the Service.

Implemented in Service.

virtual StatusCode IService::configure ( ) [pure virtual, inherited]

Configuration (from OFFLINE to CONFIGURED).

Implemented in Service.

virtual StatusCode IService::initialize ( ) [pure virtual, inherited]

Initialization (from CONFIGURED to INITIALIZED).

Implemented in ConversionSvc, DataSvc, MinimalEventLoopMgr, and Service.

virtual StatusCode IService::start ( ) [pure virtual, inherited]

Start (from INITIALIZED to RUNNING).

Implemented in MinimalEventLoopMgr, and Service.

virtual StatusCode IService::stop ( ) [pure virtual, inherited]

Stop (from RUNNING to INITIALIZED).

Implemented in MinimalEventLoopMgr, and Service.

virtual StatusCode IService::finalize ( ) [pure virtual, inherited]

Finalize (from INITIALIZED to CONFIGURED).

Implemented in ConversionSvc, DataSvc, MinimalEventLoopMgr, and Service.

virtual StatusCode IService::terminate ( ) [pure virtual, inherited]

Initialization (from CONFIGURED to OFFLINE).

Implemented in Service.

virtual StatusCode IService::reinitialize ( ) [pure virtual, inherited]

Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).

Implemented in DataSvc, MinimalEventLoopMgr, and Service.

virtual StatusCode IService::restart ( ) [pure virtual, inherited]

Initialization (from RUNNING to RUNNING, via INITIALIZED).

Implemented in MinimalEventLoopMgr, and Service.

virtual Gaudi::StateMachine::State IService::FSMState ( ) const [pure virtual, inherited]

Get the current state.

Implemented in Service.

virtual Gaudi::StateMachine::State IService::targetFSMState ( ) const [pure virtual, inherited]

When we are in the middle of a transition, get the state where the transition is leading us.

Otherwise it returns the same state as state().

Implemented in Service.

virtual void IService::setServiceManager ( ISvcManager * ) [protected, pure virtual, inherited]

Implemented in Service.

virtual const std::string& INamedInterface::name ( ) const [pure virtual, inherited]

Retrieve the name of the instance.

Implemented in Algorithm, AlgTool, Auditor, and Service.

virtual StatusCode IInterface::queryInterface	(	const InterfaceID &	riid,
		void **	ppvInterface
	)			`[pure virtual, inherited]`

Query interfaces of Interface.

Parameters:

	riid	ID of Interface to be retrieved
	ppvInterface	Pointer to Location for interface pointer

Implemented in Algorithm, AlgTool, Auditor, ConversionSvc, Converter, DataSvc, EventSelectorDataStream, MinimalEventLoopMgr, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::addRef ( ) [pure virtual, inherited]

Increment the reference count of Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::release ( ) [pure virtual, inherited]

Release Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.

virtual ChronoEntity* IChronoSvc::chronoStart ( const ChronoTag & t ) [pure virtual, inherited]

start chrono, tagged by its name

Parameters:

chrono tag (name)

Returns:: chrono object

virtual const ChronoEntity* IChronoSvc::chronoStop ( const ChronoTag & t ) [pure virtual, inherited]

stop chrono, tagged by its name

Parameters:

chrono tag (name)

Returns:: status code

virtual ChronoTime IChronoSvc::chronoDelta	(	const ChronoTag &	t,
		ChronoType	f
	)			`[pure virtual, inherited]`

return chrono delta time of last start/stop pair

Parameters:

	t	chrono tag (name)
	f	chtono type

Returns:: delta time

virtual void IChronoSvc::chronoPrint ( const ChronoTag & t ) [pure virtual, inherited]

prints (using message service) info about chrono, tagged by its name

Parameters:

chrono tag (name)

Returns:: status code

virtual ChronoStatus IChronoSvc::chronoStatus ( const ChronoTag & t ) [pure virtual, inherited]

return the status of named chrono

Parameters:

chrono tag (name)

Returns:: chrono status

virtual const ChronoEntity* IChronoSvc::chrono ( const ChronoTag & t ) const [pure virtual, inherited]

extract the chrono entity for the given tag (name)

Parameters:

chrono tag(name)

Returns:: pointer to chrono entity

virtual void IStatSvc::stat	(	const StatTag &	t,
		const StatFlag &	f
	)			`[pure virtual, inherited]`

add statistical information to the entity , tagged by its name

Parameters:

	t	stat tag(name)
	f	flag (quantity to be accumulated)

Returns:: status of stat

virtual const StatEntity* IStatSvc::stat ( const StatTag & t ) const [pure virtual, inherited]

extract the stat entity for the given tag (name)

Parameters:

stat tag(name)

Returns:: pointer to stat entity

virtual void IStatSvc::statPrint ( const StatTag & t ) [pure virtual, inherited]

prints (using message service) info about statistical entity, tagged by its name

Parameters:

stat tag(name)

Returns:: status code

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

/home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiKernel/GaudiKernel/IChronoStatSvc.h

Generated on Mon Apr 11 19:57:08 2011 for GaudiKernel by 1.4.7

In This Package:

IChronoStatSvc Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation