IPublishSvc Class Reference

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

#include <GaudiKernel/IPublishSvc.h>

Inheritance diagram for IPublishSvc:

Collaboration diagram for IPublishSvc:

Public Member Functions
	DeclareInterfaceID (IPublishSvc, 1, 0)
	InterfaceID.
virtual void	declarePubItem (const std::string &name, const bool &var)=0
	Declare publishing information.
virtual void	declarePubItem (const std::string &name, const int &var)=0
virtual void	declarePubItem (const std::string &name, const long &var)=0
virtual void	declarePubItem (const std::string &name, const double &var)=0
virtual void	declarePubItem (const std::string &name, const std::string &var)=0
virtual void	undeclarePubItem (const std::string &name)=0
	Undeclare publishing information.
virtual void	undeclarePubAll ()=0
	Undeclare all publishing information.
virtual void	updateItem (const std::string &name)=0
	Update pblishing information.
virtual void	updateAll ()=0
	Update all declared publishing items.
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 IPublishSvc interface, which publishes variables to outside monitoring processes.

Author

Beat Jost

Definition at line 23 of file IPublishSvc.h.

Member Function Documentation

DeclareInterfaceID()

IPublishSvc::DeclareInterfaceID	(	IPublishSvc	,
		1	,
		0	)

InterfaceID.

declarePubItem() [1/5]

virtual void IPublishSvc::declarePubItem ( const std::string & name, const bool & var )

pure virtual

Declare publishing information.

Parameters

name	Information name knwon to the external system
var	address of the published entity

declarePubItem() [2/5]

virtual void IPublishSvc::declarePubItem ( const std::string & name, const double & var )

pure virtual

declarePubItem() [3/5]

virtual void IPublishSvc::declarePubItem ( const std::string & name, const int & var )

pure virtual

declarePubItem() [4/5]

virtual void IPublishSvc::declarePubItem ( const std::string & name, const long & var )

pure virtual

declarePubItem() [5/5]

virtual void IPublishSvc::declarePubItem ( const std::string & name, const std::string & var )

pure virtual

undeclarePubAll()

virtual void IPublishSvc::undeclarePubAll ( )

pure virtual

Undeclare all publishing information.

undeclarePubItem()

virtual void IPublishSvc::undeclarePubItem ( const std::string & name )

pure virtual

Undeclare publishing information.

Parameters

name	publishing information name known to the external system

updateAll()

virtual void IPublishSvc::updateAll ( )

pure virtual

Update all declared publishing items.

updateItem()

virtual void IPublishSvc::updateItem ( const std::string & name )

pure virtual

Update pblishing information.

Parameters

name	publishing information name known to the external system

---

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

• GaudiKernel/include/GaudiKernel/IPublishSvc.h