ATLAS Offline Software
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
IPerfMonSvc Class Referenceabstract

#include <IPerfMonSvc.h>

Inheritance diagram for IPerfMonSvc:
Collaboration diagram for IPerfMonSvc:

Public Member Functions

virtual ~IPerfMonSvc ()
 Destructor: More...
 
PerfMon::State::Type monState () const
 Retrieve the current state of Gaudi's finite state machine. More...
 
const std::string & monStateName () const
 Retrieve the name of the current state of Gaudi's FSM. More...
 
std::vector< std::string > components (PerfMon::State::Type step) const
 return the list of components' names for a given step More...
 
virtual std::vector< std::string > components (const std::string &stepName) const =0
 return the list of components' names for a given step More...
 
virtual std::vector< std::string > io_components () const =0
 return the list of io-components' names More...
 
const PerfMon::Componentcomponent (PerfMon::State::Type step, const std::string &compName) const
 retrieve the monitored value for the component compName and for the step step (ini,evt,fin,cbk,...) More...
 
virtual const PerfMon::Componentcomponent (const std::string &stepName, const std::string &compName) const =0
 retrieve the monitored value for the component compName and for the step stepName (ini,evt,fin,cbk,...) More...
 
virtual const PerfMon::IoContainerio_component (const std::string &compName) const =0
 retrieve the I/O monitored value for the I/O component compName More...
 
virtual void domain (const std::string &compName, std::string &domain) const =0
 retrieve the domain name for a given component compName More...
 
virtual void declareInfo (const std::string &name, const bool &var, const std::string &desc, const IInterface *owner)=0
 Declare monitoring information. More...
 
virtual void declareInfo (const std::string &name, const int &var, const std::string &desc, const IInterface *owner)=0
 
virtual void declareInfo (const std::string &name, const long &var, const std::string &desc, const IInterface *owner)=0
 
virtual void declareInfo (const std::string &name, const double &var, const std::string &desc, const IInterface *owner)=0
 
virtual void declareInfo (const std::string &name, const std::string &var, const std::string &desc, const IInterface *owner)=0
 
virtual void declareInfo (const std::string &name, const std::pair< double, double > &var, const std::string &desc, const IInterface *owner)=0
 
virtual void declareInfo (const std::string &name, const AIDA::IBaseHistogram *var, const std::string &desc, const IInterface *owner)=0
 
virtual void declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc, const IInterface *owner)=0
 
virtual void declareInfo (const std::string &name, const StatEntity &var, const std::string &desc, const IInterface *owner)=0
 
virtual void undeclareInfo (const std::string &name, const IInterface *owner)=0
 Undeclare monitoring information. More...
 
virtual void undeclareAll (const IInterface *owner)=0
 Undeclare monitoring information. More...
 
virtual std::set< std::string > * getInfos (const IInterface *owner=0)=0
 Get the names for all declared monitoring informations for a given owener. More...
 
virtual void startAud (const std::string &stepName, const std::string &compName="PerfMonSlice")=0
 Start collecting monitoring data for a given component, for a given step of the Gaudi FSM. More...
 
virtual void stopAud (const std::string &stepName, const std::string &compName="PerfMonSlice")=0
 Stop collecting monitoring data for a given component, for a given step of the Gaudi FSM. More...
 

Static Public Member Functions

static const InterfaceID & interfaceID ()
 

Protected Member Functions

void setMonState (PerfMon::State::Type step)
 set the current state of the Gaudi's FSM More...
 

Private Attributes

PerfMon::State::Type m_monState
 current state of the Gaudi's FSM More...
 

Detailed Description

This is the interface to the main service scheduling a performance monitoring job.

Definition at line 37 of file IPerfMonSvc.h.

Constructor & Destructor Documentation

◆ ~IPerfMonSvc()

IPerfMonSvc::~IPerfMonSvc ( )
virtual

Destructor:

Definition at line 25 of file IPerfMonSvc.cxx.

26 {}

Member Function Documentation

◆ component() [1/2]

virtual const PerfMon::Component* IPerfMonSvc::component ( const std::string &  stepName,
const std::string &  compName 
) const
pure virtual

retrieve the monitored value for the component compName and for the step stepName (ini,evt,fin,cbk,...)

Implemented in PerfMonSvc.

◆ component() [2/2]

const PerfMon::Component* IPerfMonSvc::component ( PerfMon::State::Type  step,
const std::string &  compName 
) const
inline

retrieve the monitored value for the component compName and for the step step (ini,evt,fin,cbk,...)

Definition at line 78 of file IPerfMonSvc.h.

80  { return this->component(PerfMon::Steps[step], compName); }

◆ components() [1/2]

virtual std::vector<std::string> IPerfMonSvc::components ( const std::string &  stepName) const
pure virtual

return the list of components' names for a given step

Implemented in PerfMonSvc.

◆ components() [2/2]

std::vector<std::string> IPerfMonSvc::components ( PerfMon::State::Type  step) const
inline

return the list of components' names for a given step

Definition at line 62 of file IPerfMonSvc.h.

63  { return this->components(PerfMon::Steps[step]); }

◆ declareInfo() [1/9]

virtual void IPerfMonSvc::declareInfo ( const std::string &  name,
const AIDA::IBaseHistogram *  var,
const std::string &  desc,
const IInterface *  owner 
)
pure virtual

Implemented in PerfMonSvc.

◆ declareInfo() [2/9]

virtual void IPerfMonSvc::declareInfo ( const std::string &  name,
const bool &  var,
const std::string &  desc,
const IInterface *  owner 
)
pure virtual

Declare monitoring information.

Parameters
nameMonitoring information name knwon to the external system
varMonitoring Listener address
descTextual description
ownerOwner identifier of the monitoring information (needed to peform clean up

Implemented in PerfMonSvc.

◆ declareInfo() [3/9]

virtual void IPerfMonSvc::declareInfo ( const std::string &  name,
const double &  var,
const std::string &  desc,
const IInterface *  owner 
)
pure virtual

Implemented in PerfMonSvc.

◆ declareInfo() [4/9]

virtual void IPerfMonSvc::declareInfo ( const std::string &  name,
const int &  var,
const std::string &  desc,
const IInterface *  owner 
)
pure virtual

Implemented in PerfMonSvc.

◆ declareInfo() [5/9]

virtual void IPerfMonSvc::declareInfo ( const std::string &  name,
const long &  var,
const std::string &  desc,
const IInterface *  owner 
)
pure virtual

Implemented in PerfMonSvc.

◆ declareInfo() [6/9]

virtual void IPerfMonSvc::declareInfo ( const std::string &  name,
const StatEntity &  var,
const std::string &  desc,
const IInterface *  owner 
)
pure virtual

Implemented in PerfMonSvc.

◆ declareInfo() [7/9]

virtual void IPerfMonSvc::declareInfo ( const std::string &  name,
const std::pair< double, double > &  var,
const std::string &  desc,
const IInterface *  owner 
)
pure virtual

Implemented in PerfMonSvc.

◆ declareInfo() [8/9]

virtual void IPerfMonSvc::declareInfo ( const std::string &  name,
const std::string &  format,
const void *  var,
int  size,
const std::string &  desc,
const IInterface *  owner 
)
pure virtual

Implemented in PerfMonSvc.

◆ declareInfo() [9/9]

virtual void IPerfMonSvc::declareInfo ( const std::string &  name,
const std::string &  var,
const std::string &  desc,
const IInterface *  owner 
)
pure virtual

Implemented in PerfMonSvc.

◆ domain()

virtual void IPerfMonSvc::domain ( const std::string &  compName,
std::string &  domain 
) const
pure virtual

retrieve the domain name for a given component compName

Implemented in PerfMonSvc.

◆ getInfos()

virtual std::set<std::string>* IPerfMonSvc::getInfos ( const IInterface *  owner = 0)
pure virtual

Get the names for all declared monitoring informations for a given owener.

If the owner is NULL, then it returns for all owners informationUndeclare monitoring information

Implemented in PerfMonSvc.

◆ interfaceID()

const InterfaceID & IPerfMonSvc::interfaceID ( )
inlinestatic

Definition at line 200 of file IPerfMonSvc.h.

201 {
202  static const InterfaceID IID_IPerfMonSvc("IPerfMonSvc", 1, 0);
203  return IID_IPerfMonSvc;
204 }

◆ io_component()

virtual const PerfMon::IoContainer* IPerfMonSvc::io_component ( const std::string &  compName) const
pure virtual

retrieve the I/O monitored value for the I/O component compName

Implemented in PerfMonSvc.

◆ io_components()

virtual std::vector<std::string> IPerfMonSvc::io_components ( ) const
pure virtual

return the list of io-components' names

Implemented in PerfMonSvc.

◆ monState()

PerfMon::State::Type IPerfMonSvc::monState ( ) const
inline

Retrieve the current state of Gaudi's finite state machine.

Definition at line 53 of file IPerfMonSvc.h.

54  { return m_monState; }

◆ monStateName()

const std::string& IPerfMonSvc::monStateName ( ) const
inline

Retrieve the name of the current state of Gaudi's FSM.

Definition at line 57 of file IPerfMonSvc.h.

58  { return PerfMon::Steps[m_monState]; }

◆ setMonState()

void IPerfMonSvc::setMonState ( PerfMon::State::Type  step)
inlineprotected

set the current state of the Gaudi's FSM

Definition at line 184 of file IPerfMonSvc.h.

185  { m_monState = step; }

◆ startAud()

virtual void IPerfMonSvc::startAud ( const std::string &  stepName,
const std::string &  compName = "PerfMonSlice" 
)
pure virtual

Start collecting monitoring data for a given component, for a given step of the Gaudi FSM.

Implemented in PerfMonSvc.

◆ stopAud()

virtual void IPerfMonSvc::stopAud ( const std::string &  stepName,
const std::string &  compName = "PerfMonSlice" 
)
pure virtual

Stop collecting monitoring data for a given component, for a given step of the Gaudi FSM.

Implemented in PerfMonSvc.

◆ undeclareAll()

virtual void IPerfMonSvc::undeclareAll ( const IInterface *  owner)
pure virtual

Undeclare monitoring information.

Parameters
ownerOwner identifier of the monitoring information

Implemented in PerfMonSvc.

◆ undeclareInfo()

virtual void IPerfMonSvc::undeclareInfo ( const std::string &  name,
const IInterface *  owner 
)
pure virtual

Undeclare monitoring information.

Parameters
nameMonitoring information name knwon to the external system
ownerOwner identifier of the monitoring information

Implemented in PerfMonSvc.

Member Data Documentation

◆ m_monState

PerfMon::State::Type IPerfMonSvc::m_monState
private

current state of the Gaudi's FSM

Definition at line 193 of file IPerfMonSvc.h.


The documentation for this class was generated from the following files:
AddEmptyComponent.compName
compName
Definition: AddEmptyComponent.py:32
IPerfMonSvc::component
const PerfMon::Component * component(PerfMon::State::Type step, const std::string &compName) const
retrieve the monitored value for the component compName and for the step step (ini,...
Definition: IPerfMonSvc.h:78
IPerfMonSvc::m_monState
PerfMon::State::Type m_monState
current state of the Gaudi's FSM
Definition: IPerfMonSvc.h:193
LArCellBinning.step
step
Definition: LArCellBinning.py:158
IPerfMonSvc::components
std::vector< std::string > components(PerfMon::State::Type step) const
return the list of components' names for a given step
Definition: IPerfMonSvc.h:62