In This Package:

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:

[legend]Collaboration diagram for IMonitorSvc:[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...
Public Member Functions
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 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 owener.
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.
Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Retrieve interface ID.

---

Detailed Description

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

Author:

Philippe Vannerem

Pere Mato

Definition at line 23 of file IMonitorSvc.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.

                {
    SUCCESS = 1,
    NO_INTERFACE,
    VERSMISMATCH,
    LAST_ERROR
  };

---

Member Function Documentation

static const InterfaceID& IMonitorSvc::interfaceID

(

)

[inline, static]

Retrieve interface ID.

Reimplemented from IInterface.

Definition at line 26 of file IMonitorSvc.h.

{ return IID_IMonitorSvc; }

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 peform clean up

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

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

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

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

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

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

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]

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

Undeclare monitoring information.

Parameters:

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

virtual void IMonitorSvc::undeclareAll

(

const IInterface *

owner

)

[pure virtual]

Undeclare monitoring information.

Parameters:

owner

Owner identifier of the monitoring information

virtual std::set<std::string>* IMonitorSvc::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

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.

---

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

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

---