IMonitorSvc Class Reference

Definition of the IMonitorSvc interface, which publishes Gaudi variables to outside monitoring processes. More...

#include <GaudiKernel/IMonitorSvc.h>

Inheritance diagram for IMonitorSvc:

Collaboration diagram for IMonitorSvc:

Public Member Functions
	DeclareInterfaceID (IMonitorSvc, 4, 1)
	InterfaceID.
virtual void	declareInfo (const std::string &name, const bool &var, const std::string &desc, const IInterface *owner)=0
	Declare monitoring information.
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 StatEntity &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	undeclareInfo (const std::string &name, const IInterface *owner)=0
	Undeclare monitoring information.
virtual void	undeclareAll (const IInterface *owner)=0
	Undeclare monitoring information.
virtual std::set< std::string > *	getInfos (const IInterface *owner=0)=0
	Get the names for all declared monitoring informations for a given owner.
Public Member Functions inherited from IInterface
template<Gaudi::IsInterface TARGET>
TARGET *	cast ()
template<Gaudi::IsInterface TARGET>
TARGET const *	cast () const
template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET *	cast ()
template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET const *	cast () const
virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces.
virtual unsigned long	addRef () const =0
	Increment the reference count of Interface instance.
virtual unsigned long	release () const =0
	Release Interface instance.
virtual unsigned long	refCount () const =0
	Current reference count.
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance.
virtual	~IInterface ()=default
	Virtual destructor.
virtual void const *	i_cast (const InterfaceID &) const =0
void *	i_cast (const InterfaceID &iid)

Additional Inherited Members
Public Types inherited from IInterface
enum class	Status : StatusCode::code_t {   FAILURE = 0 , SUCCESS = 1 , NO_INTERFACE , VERSMISMATCH ,   LAST_ERROR }
	Return status. More...
using	iid = Gaudi::InterfaceId<IInterface, 0, 0>
	Interface ID.
using	ext_iids = Gaudi::interface_list<iid>
	Extra interfaces.
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface.
Protected Member Functions inherited from IInterface
virtual unsigned long	decRef () const =0
	Decrement reference count and return the new reference count.

Detailed Description

Definition of the IMonitorSvc interface, which publishes Gaudi variables to outside monitoring processes.

Author

Philippe Vannerem

Pere Mato

Definition at line 32 of file IMonitorSvc.h.

Member Function Documentation

declareInfo() [1/9]

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

pure virtual

declareInfo() [2/9]

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

pure virtual

Declare monitoring information.

Parameters

name	Monitoring information name knwon to the external system
var	Monitoring Listener address
desc	Textual description
owner	Owner identifier of the monitoring information (needed to perform clean up

declareInfo() [3/9]

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

pure virtual

declareInfo() [4/9]

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

pure virtual

declareInfo() [5/9]

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

pure virtual

declareInfo() [6/9]

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

pure virtual

declareInfo() [7/9]

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

pure virtual

declareInfo() [8/9]

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

pure virtual

declareInfo() [9/9]

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

pure virtual

DeclareInterfaceID()

IMonitorSvc::DeclareInterfaceID	(	IMonitorSvc	,
		4	,
		1	)

InterfaceID.

getInfos()

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

pure virtual

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

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

undeclareAll()

virtual void IMonitorSvc::undeclareAll ( const IInterface * owner )

pure virtual

Undeclare monitoring information.

Parameters

owner

Owner identifier of the monitoring information

undeclareInfo()

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

pure virtual

Undeclare monitoring information.

Parameters

name	Monitoring information name known to the external system
owner	Owner identifier of the monitoring information

---

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

• GaudiKernel/include/GaudiKernel/IMonitorSvc.h