Main interface for the JobOptions service. More...

Inheritance diagram for IJobOptionsSvc:

Collaboration diagram for IJobOptionsSvc:

Public Member Functions
	DeclareInterfaceID (IJobOptionsSvc, 4, 0)
	InterfaceID.
virtual StatusCode	setMyProperties (const std::string &client, IProperty *me)=0
	Override default properties of the calling client.
virtual StatusCode	addPropertyToCatalogue (const std::string &client, const Property &property)=0
	Add a property into the JobOptions catalog.
virtual StatusCode	removePropertyFromCatalogue (const std::string &client, const std::string &name)=0
	Remove a property from the JobOptions catalog.
virtual const std::vector < const Property * > *	getProperties (const std::string &client) const =0
	Get the properties associated to a given client.
virtual std::vector< std::string >	getClients () const =0
	Get the list of clients.
virtual StatusCode	readOptions (const std::string &file, const std::string &path="")=0
	look for file 'File' into search path 'Path' and read it to update existing JobOptionsCatalogue

Detailed Description

Main interface for the JobOptions service.

Definition at line 21 of file IJobOptionsSvc.h.

Member Function Documentation

virtual StatusCode IJobOptionsSvc::addPropertyToCatalogue	(	const std::string &	client,
		const Property &	property
	)		`[pure virtual]`

Add a property into the JobOptions catalog.

IJobOptionsSvc::DeclareInterfaceID	(	IJobOptionsSvc	,
		4	,
		0
	)

virtual std::vector<std::string> IJobOptionsSvc::getClients ( ) const [pure virtual]

Get the list of clients.

virtual const std::vector<const Property*>* IJobOptionsSvc::getProperties ( const std::string & client ) const [pure virtual]

Get the properties associated to a given client.

virtual StatusCode IJobOptionsSvc::readOptions	(	const std::string &	file,
		const std::string &	path = `""`
	)		`[pure virtual]`

look for file 'File' into search path 'Path' and read it to update existing JobOptionsCatalogue

Parameters:

File	file name
Path	search path

virtual StatusCode IJobOptionsSvc::removePropertyFromCatalogue	(	const std::string &	client,
		const std::string &	name
	)		`[pure virtual]`

Remove a property from the JobOptions catalog.

virtual StatusCode IJobOptionsSvc::setMyProperties	(	const std::string &	client,
		IProperty *	me
	)		`[pure virtual]`

Override default properties of the calling client.

Parameters:

client	Name of the client algorithm or service
me	Address of the interface IProperty of the client

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

/afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r0/GaudiKernel/GaudiKernel/IJobOptionsSvc.h