In This Package:

IProperty Class Reference

The IProperty is the basic interface for all components which have properties that can be set or get. More...

#include <GaudiKernel/IProperty.h>

Inheritance diagram for IProperty:

[legend]Collaboration diagram for IProperty:[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	setProperty (const Property &p)=0
	Set the property by property.
virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string.
virtual StatusCode	setProperty (const std::string &n, const std::string &v)=0
	Set the property by std::string.
virtual StatusCode	getProperty (Property *p) const =0
	Get the property by property.
virtual const Property &	getProperty (const std::string &name) const =0
	Get the property by name.
virtual StatusCode	getProperty (const std::string &n, std::string &v) const =0
	Get the property by std::string.
virtual const std::vector< Property * > &	getProperties () const =0
	Get list of properties.
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

The IProperty is the basic interface for all components which have properties that can be set or get.

Author:

Paul Maley

Pere Mato

Date:

29/10/98

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

(

)

[inline, static]

Retrieve interface ID.

Reimplemented from IInterface.

Definition at line 28 of file IProperty.h.

{ return IID_IProperty; }

virtual StatusCode IProperty::setProperty

(

const Property &

p

)

[pure virtual]

Set the property by property.

Implemented in Algorithm, AlgTool, Auditor, PropertyMgr, and Service.

virtual StatusCode IProperty::setProperty

(

const std::string &

s

)

[pure virtual]

Set the property by string.

Implemented in Algorithm, AlgTool, Auditor, PropertyMgr, and Service.

virtual StatusCode IProperty::setProperty	(	const std::string &	n,
		const std::string &	v
	)			[pure virtual]

Set the property by std::string.

Implemented in Algorithm, AlgTool, Auditor, PropertyMgr, and Service.

virtual StatusCode IProperty::getProperty

(

Property *

p

)

const [pure virtual]

Get the property by property.

Implemented in Algorithm, AlgTool, Auditor, PropertyMgr, and Service.

virtual const Property& IProperty::getProperty

(

const std::string &

name

)

const [pure virtual]

Get the property by name.

Implemented in Algorithm, AlgTool, Auditor, PropertyMgr, and Service.

virtual StatusCode IProperty::getProperty	(	const std::string &	n,
		std::string &	v
	)			const [pure virtual]

Get the property by std::string.

Implemented in Algorithm, AlgTool, Auditor, PropertyMgr, and Service.

virtual const std::vector<Property*>& IProperty::getProperties

(

)

const [pure virtual]

Get list of properties.

Implemented in Algorithm, AlgTool, Auditor, PropertyMgr, and Service.

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

---