| The Gaudi Framework v27r1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Private Attributes | List of all members
PropertyList Class Reference

List of properties. More...

`#include <GaudiKernel/PropertyList.h>`

Inheritance diagram for PropertyList:
[legend]
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)
| Property implementation: set property. More...
bool | load (Property &p) const
| 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 (const std::string &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 Property
const std::string & | name () const
| property name More...
const std::string & | documentation () const
| property documentation 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...
const std::function< void(Property &)> & | readCallBack () const
| get a reference to the readCallBack More...
const std::function< void(Property &)> & | updateCallBack () const
| get a reference to the updateCallBack More...
virtual Property & | declareReadHandler (std::function< void(Property &)> fun)
| set new callback for reading More...
virtual Property & | declareUpdateHandler (std::function< void(Property &)> fun)
| set new callback for update More...
template<class HT >
Property & | declareReadHandler (void(HT::*MF)(Property &), HT *instance)
template<class HT >
Property & | declareUpdateHandler (void(HT::*MF)(Property &), HT *instance)
virtual void | useReadHandler () const
| use the call-back function at reading More...
virtual bool | useUpdateHandler ()
| use the call-back function at update More...
virtual | ~Property ()=default
| virtual destructor More...
virtual Property * | clone () const =0
| clone: "virtual constructor" More...
void | setName (std::string value)
| set the new value for the property name More...
void | setDocumentation (std::string documentation)
| set the documentation string More...
virtual std::ostream & | fillStream (std::ostream &) const
| the printout of the property value More...

## Private Attributes
std::vector< Property * > | m_propertyList

## Additional Inherited Members
Protected Member Functions inherited from Property
| Property (const std::type_info &type, std::string name="")
| constructor from the property name and the type More...
| Property (std::string name, const std::type_info &type)
| constructor from the property name and the type More...
| Property (const Property &)=default
| copy constructor More...
Property & | operator= (const Property &)=default
| assignment operator More...
Protected Attributes inherited from Property
std::function< void(Property &)> | m_readCallBack
std::function< void(Property &)> | m_updateCallBack

## Detailed Description

List of properties.

Author
  David Quarrie
  Pere Mato

Definition at line 16 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 26 of file PropertyList.h.

26 { 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 52 of file PropertyList.h.

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

- GaudiKernel/GaudiKernel/PropertyList.h