In This Package:

IJobOptionsSvc Class Reference

Main interface for the JobOptions service. More...

#include <GaudiKernel/IJobOptionsSvc.h>

Inheritance diagram for IJobOptionsSvc:

[legend]Collaboration diagram for IJobOptionsSvc:[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 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
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

Main interface for the JobOptions service.

Author:

Pere Mato

Definition at line 25 of file IJobOptionsSvc.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& IJobOptionsSvc::interfaceID

(

)

[inline, static]

Retrieve interface ID.

Reimplemented from IInterface.

Definition at line 28 of file IJobOptionsSvc.h.

{ return IID_IJobOptionsSvc; }

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

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

Add a property into the JobOptions catalog.

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

Remove a property from the JobOptions catalog.

virtual const std::vector<const Property*>* IJobOptionsSvc::getProperties

(

const std::string &

client

)

const [pure virtual]

Get the properties associated to a given client.

virtual std::vector<std::string> IJobOptionsSvc::getClients

(

)

const [pure virtual]

Get the list of clients.

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

Returns:

status code

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/IJobOptionsSvc.h

---