PropertyList Class Reference

List of properties. More...

#include <GaudiKernel/PropertyList.h>

Inheritance diagram for PropertyList:

Collaboration diagram for PropertyList:

Public Member Functions
	PropertyList ()
	Constructor.
	PropertyList (const std::string &name)
	Constructor giving a name.
virtual	~PropertyList ()
	Virtual destructor.
bool	isRef () const
	Accessor members (const)
void	addProperty (const std::string &name, Property &p)
	Add a property to the list.
void	addProperty (Property &p)
	Add a property to the list.
void	removeProperty (const std::string &name)
	Remove a property from the list.
void	removeProperty (Property &p)
	Remove a property from the list.
bool	assign (const Property &p)
	Property implementation: set property.
bool	load (Property &p) const
	Property implementation: get property.
bool	assign (const std::string &name, const Property &p)
	Property implementation: set property.
bool	load (const std::string &name, Property &p) const
	Property implementation: get property.
const Property &	getProperty (const std::string &name) const
	Get the property with a given name.
const std::vector< Property * > &	getProperties () const
	Get the complete list of properties.
Public Member Functions inherited from Property
const std::string &	name () const
	property name
const std::string &	documentation () const
	property documentation
const std::type_info *	type_info () const
	property type-info
std::string	type () const
	property type
virtual std::string	toString () const =0
	value -> string
virtual void	toStream (std::ostream &out) const =0
	value -> stream
virtual StatusCode	fromString (const std::string &value)=0
	string -> value
const PropertyCallbackFunctor *	readCallBack () const
	Call-back functor at reading: the functor is owned by property!
const PropertyCallbackFunctor *	updateCallBack () const
	Call-back functor for update: the functor is owned by property!
virtual void	declareReadHandler (PropertyCallbackFunctor *pf)
	set new callback for reading
virtual void	declareUpdateHandler (PropertyCallbackFunctor *pf)
	set new callback for update
template<class HT >
void	declareReadHandler (void(HT::*MF)(Property &), HT *instance)
template<class HT >
void	declareUpdateHandler (void(HT::*MF)(Property &), HT *instance)
virtual void	useReadHandler () const
	use the call-back function at reading
virtual bool	useUpdateHandler ()
	use the call-back function at update
virtual	~Property ()
	virtual destructor
virtual Property *	clone () const =0
	clone: "virtual constructor"
void	setName (const std::string &value)
	set the new value for the property name
void	setDocumentation (const std::string &documentation)
	set the documentation string
virtual std::ostream &	fillStream (std::ostream &) const
	the printout of the property value

Private Attributes
std::vector< Property * >	m_propertyList

Additional Inherited Members
Protected Member Functions inherited from Property
	Property (const std::type_info &type, const std::string &name="")
	constructor from the property name and the type
	Property (const std::string &name, const std::type_info &type)
	constructor from the property name and the type
	Property (const Property &right)
	copy constructor
Property &	operator= (const Property &right)
	assignment operator
Protected Attributes inherited from Property
PropertyCallbackFunctor *	m_readCallBack
PropertyCallbackFunctor *	m_updateCallBack

Detailed Description

List of properties.

Author

David Quarrie

Pere Mato

Definition at line 17 of file PropertyList.h.

Constructor & Destructor Documentation

PropertyList::PropertyList

(

)

Constructor.

PropertyList::PropertyList

(

const std::string &

name

)

Constructor giving a name.

virtual PropertyList::~PropertyList ( )

virtual

Virtual destructor.

Member Function Documentation

void PropertyList::addProperty	(	const std::string &	name,
		Property &	p
	)

Add a property to the list.

void PropertyList::addProperty

(

Property &

p

)

Add a property to the list.

bool PropertyList::assign ( const Property &  p )

virtual

Property implementation: set property.

Implements Property.

bool PropertyList::assign	(	const std::string &	name,
		const Property &	p
	)

Property implementation: set property.

const std::vector<Property*>& PropertyList::getProperties

(

)

const

Get the complete list of properties.

const Property& PropertyList::getProperty

(

const std::string &

name

)

const

Get the property with a given name.

bool PropertyList::isRef ( ) const

inline

Accessor members (const)

Definition at line 27 of file PropertyList.h.

{ return false; }

bool PropertyList::load ( Property &  p ) const

virtual

Property implementation: get property.

Implements Property.

bool PropertyList::load	(	const std::string &	name,
		Property &	p
	)		const

Property implementation: get property.

void PropertyList::removeProperty

(

const std::string &

name

)

Remove a property from the list.

void PropertyList::removeProperty

(

Property &

p

)

Remove a property from the list.

Member Data Documentation

std::vector<Property*> PropertyList::m_propertyList

private

Definition at line 53 of file PropertyList.h.

---

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

• /afs/.cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r9/GaudiKernel/GaudiKernel/PropertyList.h