A container for holding references to properties. More...
#include <PropertyBag.hpp>
Classes | |
struct | FindPropType |
Public Types | |
typedef Properties::const_iterator | const_iterator |
typedef Properties::iterator | iterator |
typedef std::vector< std::string > | Names |
typedef std::vector < base::PropertyBase * > | Properties |
typedef Properties | PropertyContainerType |
Public Member Functions | |
void | add (base::PropertyBase *p) |
template<class T > | |
Property< T > & | addProperty (const std::string &name, T &attr) |
bool | addProperty (base::PropertyBase &p) |
iterator | begin () |
const_iterator | begin () const |
void | clear () |
bool | empty () const |
iterator | end () |
const_iterator | end () const |
base::PropertyBase * | find (const std::string &name) const |
template<class T > | |
base::PropertyBase * | findValue (const T &value) const |
base::PropertyBase * | getItem (int i) const |
Properties & | getProperties () |
const Properties & | getProperties () const |
Properties | getProperties (const std::string &name) const |
base::PropertyBase * | getProperty (const std::string &name) const |
Names | getPropertyNames () const |
template<class T > | |
Property< T > * | getPropertyType (const std::string &name) const |
const std::string & | getType () const |
void | identify (base::PropertyIntrospection *pi) const |
void | identify (base::PropertyBagVisitor *pi) const |
void | list (Names &names) const |
Names | list () const |
PropertyBag & | operator<< (base::PropertyBase *item) |
PropertyBag & | operator<<= (const PropertyBag &source) |
PropertyBag & | operator= (const PropertyBag &orig) |
bool | ownProperty (base::PropertyBase *p) |
bool | ownsProperty (base::PropertyBase *p) const |
PropertyBag () | |
PropertyBag (const std::string &_type) | |
PropertyBag (const PropertyBag &orig) | |
The copy constructor. The copy constructor of the PropertyBag makes non-deep copies of its elements. | |
void | remove (base::PropertyBase *p) |
bool | removeProperty (base::PropertyBase *p) |
void | setType (const std::string &newtype) |
size_t | size () const |
~PropertyBag () | |
Protected Attributes | |
Properties | mowned_props |
Properties | mproperties |
std::string | type |
A container for holding references to properties.
This class groups properties of different types into a single container. A PropertyBag object can handed to a marsh::Marshaller object which will serialize the contents of the PropertyBag.
All operations on a PropertyBag are non recursive. The PropertyBag itself is not aware of the possible hierarchical structure. You need to use the global scope functions for handling hierarchical structures.
A PropertyBag is not the owner of the properties within. It defines a group of properties, nothing more. When this group of properties contains another PropertyBag, this bag is considered as a 'pointer' to other properties. Even such a bag is not owned by the PropertyBag.
It can happen in an application that a PropertyBag is filled with dynamically created Property objects. The bag is not responsible for cleaning up these objects once they are no longer needed. The application which uses the PropertyBag has to find a way of deleting the possible dangling pointers.
To add a Property<ClassT> prop to a PropertyBag bag, use
bag.add(&prop).
To retrieve this property, either use find or getProperty to retrieve a Property by name :
base::PropertyBase* pb = bag.find( "name" ). Property<ClassT> pb = bag.getProperty( "name" ).
Both will return null if no such property exists.
Definition at line 96 of file PropertyBag.hpp.
typedef Properties::const_iterator RTT::PropertyBag::const_iterator |
A const iterator over the Properties.
Definition at line 114 of file PropertyBag.hpp.
typedef Properties::iterator RTT::PropertyBag::iterator |
An iterator over the Properties.
Definition at line 110 of file PropertyBag.hpp.
typedef std::vector<std::string> RTT::PropertyBag::Names |
The container to hold names of Properties.
Definition at line 119 of file PropertyBag.hpp.
typedef std::vector<base::PropertyBase*> RTT::PropertyBag::Properties |
The container in which the properties are stored.
Definition at line 102 of file PropertyBag.hpp.
Deprecated, use Properties.
Definition at line 106 of file PropertyBag.hpp.
The default constructor.
Definition at line 54 of file PropertyBag.cpp.
RTT::PropertyBag::PropertyBag | ( | const std::string & | _type | ) |
The typed constructor.
type | The type of PropertyBag. |
Definition at line 58 of file PropertyBag.cpp.
RTT::PropertyBag::PropertyBag | ( | const PropertyBag & | orig | ) |
The copy constructor. The copy constructor of the PropertyBag makes non-deep copies of its elements.
Definition at line 62 of file PropertyBag.cpp.
Destroy this object and destroy all owned properties.
Definition at line 75 of file PropertyBag.cpp.
void RTT::PropertyBag::add | ( | base::PropertyBase * | p | ) |
Add a valid property to the container. Analogous to addProperty.
p | Pointer to the property to be added. |
Definition at line 80 of file PropertyBag.cpp.
Property<T>& RTT::PropertyBag::addProperty | ( | const std::string & | name, |
T & | attr | ||
) | [inline] |
Adds a variable of any type as a property to this bag. A Property is created which causes contents of the property always to be in sync with the contents of attr.
name | The name of this property |
attr | The variable that will be aliased. |
Definition at line 166 of file PropertyBag.hpp.
bool RTT::PropertyBag::addProperty | ( | base::PropertyBase & | p | ) |
Add a valid property to the container.
p | Pointer to the property to be added. |
Definition at line 112 of file PropertyBag.cpp.
iterator RTT::PropertyBag::begin | ( | ) | [inline] |
Definition at line 353 of file PropertyBag.hpp.
const_iterator RTT::PropertyBag::begin | ( | ) | const [inline] |
Definition at line 354 of file PropertyBag.hpp.
void RTT::PropertyBag::clear | ( | ) |
Removes all PropertyBases from this bag, without deleting them. This is a not recursive function.
Definition at line 139 of file PropertyBag.cpp.
bool RTT::PropertyBag::empty | ( | ) | const [inline] |
Return true if no properties are present in this bag.
Definition at line 219 of file PropertyBag.hpp.
iterator RTT::PropertyBag::end | ( | ) | [inline] |
Definition at line 355 of file PropertyBag.hpp.
const_iterator RTT::PropertyBag::end | ( | ) | const [inline] |
Definition at line 356 of file PropertyBag.hpp.
PropertyBase * RTT::PropertyBag::find | ( | const std::string & | name | ) | const |
Find the base::PropertyBase with name name. This function returns the first match.
name | The name of the property to search for. |
Definition at line 217 of file PropertyBag.cpp.
base::PropertyBase* RTT::PropertyBag::findValue | ( | const T & | value | ) | const [inline] |
Finds the base::PropertyBase by value. This function returns the first match.
value | The value the Property should have |
T | The data type of the value. |
Definition at line 295 of file PropertyBag.hpp.
base::PropertyBase* RTT::PropertyBag::getItem | ( | int | i | ) | const [inline] |
Returns the i'th Property, starting from 0.
Definition at line 254 of file PropertyBag.hpp.
Properties& RTT::PropertyBag::getProperties | ( | ) | [inline] |
Returns a list of all the property objects in this bag.
Definition at line 336 of file PropertyBag.hpp.
const Properties& RTT::PropertyBag::getProperties | ( | ) | const [inline] |
Returns a list of all the property objects in this bag.
Definition at line 341 of file PropertyBag.hpp.
PropertyBag::Properties RTT::PropertyBag::getProperties | ( | const std::string & | name | ) | const |
Returns a list of all property objects with the name name.
Definition at line 173 of file PropertyBag.cpp.
base::PropertyBase * RTT::PropertyBag::getProperty | ( | const std::string & | name | ) | const |
Get a Property with name name.
name | The name of the property to search for. |
Definition at line 225 of file PropertyBag.cpp.
Names RTT::PropertyBag::getPropertyNames | ( | ) | const [inline] |
Returns a list of all the names of the properties in this bag.
Definition at line 351 of file PropertyBag.hpp.
Property<T>* RTT::PropertyBag::getPropertyType | ( | const std::string & | name | ) | const [inline] |
Get the first Property with name name of a given type T
name | The name of the property to search for. |
T | The data type of the property. |
Definition at line 242 of file PropertyBag.hpp.
const std::string& RTT::PropertyBag::getType | ( | ) | const [inline] |
Definition at line 329 of file PropertyBag.hpp.
void RTT::PropertyBag::identify | ( | base::PropertyIntrospection * | pi | ) | const |
Identify the contents of this bag through introspection.
Definition at line 187 of file PropertyBag.cpp.
void RTT::PropertyBag::identify | ( | base::PropertyBagVisitor * | pi | ) | const |
Identify the contents of this bag through introspection.
Definition at line 197 of file PropertyBag.cpp.
void RTT::PropertyBag::list | ( | Names & | names | ) | const |
List the names of all properties.
names | The container which will be used to store all available property names in. |
Definition at line 151 of file PropertyBag.cpp.
std::vector< std::string > RTT::PropertyBag::list | ( | ) | const |
List the names of all properties.
Definition at line 161 of file PropertyBag.cpp.
PropertyBag& RTT::PropertyBag::operator<< | ( | base::PropertyBase * | item | ) | [inline] |
The 'add' operator. Equivalent to add().
item | The Property to add to this bag. |
Definition at line 327 of file PropertyBag.hpp.
PropertyBag & RTT::PropertyBag::operator<<= | ( | const PropertyBag & | source | ) |
The update operator. It updates this bag so it contains all PropertyBases of another bag, removing own PropertyBases if duplicate names exist in the source bag.
Definition at line 251 of file PropertyBag.cpp.
PropertyBag & RTT::PropertyBag::operator= | ( | const PropertyBag & | orig | ) |
This assignment assigns all PropertyBases of another bag in this bag, making an exact copy or the original.
Definition at line 234 of file PropertyBag.cpp.
bool RTT::PropertyBag::ownProperty | ( | base::PropertyBase * | p | ) |
Set a property to be owned by this bag.
Definition at line 90 of file PropertyBag.cpp.
bool RTT::PropertyBag::ownsProperty | ( | base::PropertyBase * | p | ) | const |
Returns true if this property is owned by this Bag.
Definition at line 102 of file PropertyBag.cpp.
void RTT::PropertyBag::remove | ( | base::PropertyBase * | p | ) |
Remove a property from the container. Analogous to removeProperty.
p | Pointer to the property to be removed. |
Definition at line 85 of file PropertyBag.cpp.
bool RTT::PropertyBag::removeProperty | ( | base::PropertyBase * | p | ) |
Remove a property from the container.
p | Pointer to the property to be removed. |
Definition at line 122 of file PropertyBag.cpp.
void RTT::PropertyBag::setType | ( | const std::string & | newtype | ) | [inline] |
Definition at line 331 of file PropertyBag.hpp.
size_t RTT::PropertyBag::size | ( | ) | const [inline] |
Get the number of Properties in this bag.
Definition at line 264 of file PropertyBag.hpp.
Properties RTT::PropertyBag::mowned_props [protected] |
Definition at line 359 of file PropertyBag.hpp.
Properties RTT::PropertyBag::mproperties [protected] |
Definition at line 358 of file PropertyBag.hpp.
std::string RTT::PropertyBag::type [protected] |
Definition at line 370 of file PropertyBag.hpp.