In This Package:

PropertyList Class Reference

List of properties. More...

#include <GaudiKernel/PropertyList.h>

Inheritance diagram for PropertyList:

[legend]Collaboration diagram for PropertyList:[legend]List of all members.

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.
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 StatusCode	fromString (const std::string &value)=0
	string -> value
const PropertyCallbackFunctor *	readCallBack () const
	Call-back functor at reading: the functor is ownered by property!
const PropertyCallbackFunctor *	updateCallBack () const
	Call-back functor for update: the funtor is ownered by property!
virtual void	declareReadHandler (PropertyCallbackFunctor *pf)
	set new callback for reading
template<class HT>
void	declareReadHandler (void(HT::*MF)(Property &), HT *instance)
virtual void	declareUpdateHandler (PropertyCallbackFunctor *pf)
	set new callback for update
template<class HT>
void	declareUpdateHandler (void(HT::*MF)(Property &), HT *instance)
virtual void	useReadHandler () const
	use the call-back function at reading
virtual void	useUpdateHandler ()
	use the call-back function at update
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
Protected Attributes
PropertyCallbackFunctor *	m_readCallBack
PropertyCallbackFunctor *	m_updateCallBack
Private Attributes
std::vector< Property * >	m_propertyList

---

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

bool PropertyList::isRef

(

)

const [inline]

Accessor members (const).

Definition at line 27 of file PropertyList.h.

{ return false; }

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.

void PropertyList::removeProperty

(

const std::string &

name

)

Remove a property from the list.

void PropertyList::removeProperty

(

Property &

p

)

Remove a property from the list.

bool PropertyList::assign

(

const Property &

p

)

[virtual]

Property implementation: set property.

Implements Property.

bool PropertyList::load

(

Property &

p

)

const [virtual]

Property implementation: get property.

Implements Property.

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

Property implementation: set property.

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

Property implementation: get property.

const Property& PropertyList::getProperty

(

const std::string &

name

)

const

Get the property with a given name.

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

(

)

const

Get the complete list of properties.

const std::string& Property::name

(

)

const [inline, inherited]

property name

Definition at line 50 of file Property.h.

{ return m_name             ; } ;

const std::string& Property::documentation

(

)

const [inline, inherited]

property documentation

Definition at line 52 of file Property.h.

{ return m_documentation; };

const std::type_info* Property::type_info

(

)

const [inline, inherited]

property type-info

Definition at line 54 of file Property.h.

{ return m_typeinfo         ; } ;

std::string Property::type

(

)

const [inline, inherited]

property type

Definition at line 56 of file Property.h.

{ return m_typeinfo->name() ; } ;

virtual std::string Property::toString

(

)

const [pure virtual, inherited]

value -> string

Implemented in PropertyWithValue< TYPE >, GaudiHandleProperty, GaudiHandleArrayProperty, and PropertyWithValue< TYPE >.

virtual StatusCode Property::fromString

(

const std::string &

value

)

[pure virtual, inherited]

string -> value

Implemented in PropertyWithValue< TYPE >, GaudiHandleProperty, and GaudiHandleArrayProperty.

const PropertyCallbackFunctor* Property::readCallBack

(

)

const [inherited]

Call-back functor at reading: the functor is ownered by property!

const PropertyCallbackFunctor* Property::updateCallBack

(

)

const [inherited]

Call-back functor for update: the funtor is ownered by property!

virtual void Property::declareReadHandler

(

PropertyCallbackFunctor *

pf

)

[virtual, inherited]

set new callback for reading

template<class HT>

void Property::declareReadHandler	(	void(HT::*)(Property &)	MF,
		HT *	instance
	)			[inline, inherited]

Definition at line 131 of file Property.h.

{ declareReadHandler ( new PropertyCallbackMemberFunctor< HT >( MF , obj ) ) ; }

virtual void Property::declareUpdateHandler

(

PropertyCallbackFunctor *

pf

)

[virtual, inherited]

set new callback for update

template<class HT>

void Property::declareUpdateHandler	(	void(HT::*)(Property &)	MF,
		HT *	instance
	)			[inline, inherited]

Definition at line 136 of file Property.h.

{ declareUpdateHandler ( new PropertyCallbackMemberFunctor< HT >( MF , obj ) ) ; }

virtual void Property::useReadHandler

(

)

const [virtual, inherited]

use the call-back function at reading

virtual void Property::useUpdateHandler

(

)

[virtual, inherited]

use the call-back function at update

virtual Property* Property::clone

(

)

const [pure virtual, inherited]

clone: "virtual constructor"

Implemented in SimpleProperty< TYPE, VERIFIER >, SimplePropertyRef< TYPE, VERIFIER >, GaudiHandleProperty, and GaudiHandleArrayProperty.

void Property::setName

(

const std::string &

value

)

[inline, inherited]

set the new value for the property name

Definition at line 91 of file Property.h.

{ m_name = value ; }

void Property::setDocumentation

(

const std::string &

documentation

)

[inline, inherited]

set the documentation string

Definition at line 93 of file Property.h.

                                                          {
    m_documentation = documentation; };

virtual std::ostream& Property::fillStream

(

std::ostream &

)

const [virtual, inherited]

the printout of the property value

---

Member Data Documentation

std::vector<Property*> PropertyList::m_propertyList [private]

Definition at line 53 of file PropertyList.h.

PropertyCallbackFunctor* Property::m_readCallBack [mutable, protected, inherited]

Definition at line 122 of file Property.h.

PropertyCallbackFunctor* Property::m_updateCallBack [protected, inherited]

Definition at line 124 of file Property.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiKernel/GaudiKernel/PropertyList.h

---