#include <GaudiKernel/PropertyList.h>

Inheritance diagram for PropertyList:

Collaboration diagram for PropertyList:

[legend]

Public Member Functions
	PropertyList ()
	Constructor. More...

	PropertyList (const std::string &name)
	Constructor giving a name. More...

virtual	~PropertyList ()
	Virtual destructor. More...

bool	isRef () const
	Accessor members (const) More...

void	addProperty (const std::string &name, Property &p)
	Add a property to the list. More...

void	addProperty (Property &p)
	Add a property to the list. More...

void	removeProperty (const std::string &name)
	Remove a property from the list. More...

void	removeProperty (Property &p)
	Remove a property from the list. More...

bool	assign (const Property &p) override
	Property implementation: set property. More...

bool	load (Property &p) const override
	Property implementation: get property. More...

bool	assign (const std::string &name, const Property &p)
	Property implementation: set property. More...

bool	load (const std::string &name, Property &p) const
	Property implementation: get property. More...

const Property &	getProperty (std::string_view name) const
	Get the property with a given name. More...

const std::vector< Property * > &	getProperties () const
	Get the complete list of properties. More...

Public Member Functions inherited from Gaudi::Details::PropertyBase
const std::string	name () const
	property name More...

std::string	documentation () const
	property documentation More...

std::string	semantics () const
	property semantics More...

const std::type_info *	type_info () const
	property type-info More...

std::string	type () const
	property type More...

virtual std::string	toString () const =0
	value -> string More...

virtual void	toStream (std::ostream &out) const =0
	value -> stream More...

virtual StatusCode	fromString (const std::string &value)=0
	string -> value More...

virtual PropertyBase &	declareReadHandler (std::function< void(PropertyBase &)> fun)=0
	set new callback for reading More...

virtual PropertyBase &	declareUpdateHandler (std::function< void(PropertyBase &)> fun)=0
	set new callback for update More...

virtual const std::function< void(PropertyBase &)>	readCallBack () const =0
	get a reference to the readCallBack More...

virtual const std::function< void(PropertyBase &)>	updateCallBack () const =0
	get a reference to the updateCallBack More...

virtual bool	useUpdateHandler ()=0
	manual trigger for callback for update More...

template<class HT >
PropertyBase &	declareReadHandler (void(HT::MF)(PropertyBase &), HT instance)

template<class HT >
PropertyBase &	declareUpdateHandler (void(HT::MF)(PropertyBase &), HT instance)

virtual	~PropertyBase ()
	virtual destructor More...

void	setName (std::string value)
	set the new value for the property name More...

void	setDocumentation (std::string value)
	set the documentation string More...

void	setSemantics (std::string value)
	set the semantics string More...

virtual std::ostream &	fillStream (std::ostream &) const
	the printout of the property value More...

virtual PropertyBase *	clone () const =0
	clones the current property More...

void	setOwnerType (const std::type_info &ownerType)
	set the type of the owner class (used for documentation) More...

template<class OWNER >
void	setOwnerType ()
	set the type of the owner class (used for documentation) More...

const std::type_info *	ownerType () const
	get the type of the owner class (used for documentation) More...

std::string	ownerTypeName () const
	get the string for the type of the owner class (used for documentation) More...

Private Attributes
std::vector< Property * >	m_propertyList

Additional Inherited Members
Protected Member Functions inherited from Gaudi::Details::PropertyBase
	PropertyBase (const std::type_info &type, std::string name="", std::string doc="", std::string semantics="")
	constructor from the property name and the type More...

	PropertyBase (std::string name, const std::type_info &type)
	constructor from the property name and the type More...

	PropertyBase (const PropertyBase &)=default
	copy constructor More...

PropertyBase &	operator= (const PropertyBase &)=default
	assignment operator More...

Detailed Description

List of properties.

Author: David Quarrie; Pere Mato

Definition at line 26 of file PropertyList.h.

Constructor & Destructor Documentation

◆ PropertyList() [1/2]

PropertyList::PropertyList ( )

Constructor.

◆ PropertyList() [2/2]

PropertyList::PropertyList ( const std::string & name )

Constructor giving a name.

◆ ~PropertyList()

virtual PropertyList::~PropertyList ( )

virtual

Virtual destructor.

Member Function Documentation

◆ addProperty() [1/2]

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

Add a property to the list.

◆ addProperty() [2/2]

void PropertyList::addProperty ( Property & p )

Add a property to the list.

◆ assign() [1/2]

bool PropertyList::assign ( const Property & p )

overridevirtual

Property implementation: set property.

Implements Gaudi::Details::PropertyBase.

◆ assign() [2/2]

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

Property implementation: set property.

◆ getProperties()

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

Get the complete list of properties.

◆ getProperty()

const Property& PropertyList::getProperty ( std::string_view name ) const

Get the property with a given name.

◆ isRef()

bool PropertyList::isRef ( ) const

inline

Accessor members (const)

Definition at line 36 of file PropertyList.h.

36 { return false; }

◆ load() [1/2]

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

Property implementation: get property.

◆ load() [2/2]

bool PropertyList::load ( Property & p ) const

overridevirtual

Property implementation: get property.

Implements Gaudi::Details::PropertyBase.

◆ removeProperty() [1/2]

void PropertyList::removeProperty ( const std::string & name )

Remove a property from the list.

◆ removeProperty() [2/2]

void PropertyList::removeProperty ( Property & p )

Remove a property from the list.

Member Data Documentation

◆ m_propertyList

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

private

Definition at line 63 of file PropertyList.h.

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

GaudiKernel/include/GaudiKernel/PropertyList.h

Public Member Functions

Private Attributes

Additional Inherited Members