cartobase  4.5.0
carto::PropertySet Class Reference

A dictionary generic Object. More...

#include <cartobase/object/property.h>

Inheritance diagram for carto::PropertySet:
Collaboration diagram for carto::PropertySet:

Classes

class  iterator
 

Public Types

typedef ::sigc::signal3< void,
const Object &, const
std::string &, const Object & > 
Signal
 This signal type informs the slots about the sender (this), the property name and its old value. More...
 
- Public Types inherited from carto::RCObject
typedef int RefCounterType
 

Public Member Functions

 PropertySet ()
 
 PropertySet (const PropertySet &)
 
PropertySetoperator= (const PropertySet &)
 
virtual ~PropertySet ()
 
SignalgetSignalPropertyChanged ()
 
template<typename T >
void addBuiltinProperty (const std::string &, T &)
 
template<typename T >
void addBuiltinProperty (const std::string &, T &, bool &provided)
 add an optional builtin property More...
 
template<typename T >
bool getProperty (const std::string &, T &) const
 
template<typename T >
void setProperty (const std::string &, const T &)
 
virtual bool getProperty (const std::string &, Object &) const
 Access the element ok key key. More...
 
virtual void setProperty (const std::string &, Object)
 Set (insert or replace) the element of key key with the value object. More...
 
virtual bool removeProperty (const std::string &)
 remove an element. More...
 
virtual bool hasProperty (const std::string &) const
 check if an element exists under the key key More...
 
virtual size_t size () const
 Number of sub-elements. More...
 
virtual void clearProperties ()
 clear the dictionary More...
 
virtual void copyBuiltinProperties (const PropertySet &source)
 
virtual Object objectIterator () const
 returns an object implementing the IteratorIntrerface More...
 
iterator getIterator () const
 
- Public Member Functions inherited from carto::RCObject
 RCObject ()
 
 RCObject (const RCObject &)
 
RCObjectoperator= (const RCObject &)
 
- Public Member Functions inherited from carto::DictionaryInterface
virtual ~DictionaryInterface ()
 
virtual bool isDictionary () const
 Returns false if the stored object doesn't actually implement the DictionaryInterface API (needed since all GenericObject inherit this interface whatever they actually contain) More...
 
Object getProperty (const std::string &) const
 same as the other getProperty() functions except that the value object is returned. More...
 
Object getProperty (Object key) const
 same as the other getProperty() functions except that the key is contained in the key argument (which must implement the StringInterface). More...
 
template<typename T >
bool getProperty (const std::string &key, T &value) const
 same as the other getProperty() functions except that the value object must be of exact type T and is copied to the value argument. More...
 
void setProperty (const std::string &, const char *)
 specific specialization: C strings are stored as std::string objects More...
 
template<typename T >
void setProperty (const std::string &, const T &)
 same as the other setProperty() functions except that the value to be set is of the arbitrary type T and will possibly be stored in an Object. More...
 
virtual void copyProperties (Object source)
 copy all properties of the source object to this object. More...
 
virtual bool operator== (const DictionaryInterface &other) const
 equality test More...
 
virtual bool operator!= (const DictionaryInterface &other) const
 
template<>
void setProperty (const std::string &key, Object const &value)
 
template<>
bool getProperty (const std::string &key, Object &value) const
 
- Public Member Functions inherited from carto::SizeInterface
virtual ~SizeInterface ()
 
- Public Member Functions inherited from carto::Interface
virtual ~Interface ()
 
- Public Member Functions inherited from carto::IterableInterface
virtual ~IterableInterface ()
 
virtual bool isIterable () const
 Returns false if the stored object doesn't actually implement the IterableInterface API (needed since all GenericObject inherit this interface whatever they actually contain) More...
 
virtual bool operator== (const IterableInterface &other) const
 equality test More...
 
virtual bool operator!= (const IterableInterface &other) const
 

Detailed Description

A dictionary generic Object.

PropertySet can replace a std::map<std::string,Object> in GenericObject implementations, and offers additional interesting features:

  • builtin properties support: a builtin property is a reference to an external existing variable (generally a member of a structure or class tied to the property set). They are used transparently just like any other dynamic properties, but as they use lower-level underlying variables, this allows optimizations in special cases when a program knows it operates on the exact intentded structure without breaking compatibility with the generic API. \ A builtin property can change value, but cannot change type because it references a typed value at a fixed memory location.
  • signal / slot support: signals are emitted whenever a property changes. The "raw" signal support is a low-level mechanism which fires every time any property changes. For a more convenient behaviour, a filter mechanism can be used in conjunction with Propertyset: PropertyFilter

Definition at line 75 of file property.h.

Member Typedef Documentation

typedef ::sigc::signal3< void, const Object &, const std::string&, const Object& > carto::PropertySet::Signal

This signal type informs the slots about the sender (this), the property name and its old value.

Definition at line 82 of file property.h.

Constructor & Destructor Documentation

carto::PropertySet::PropertySet ( )
carto::PropertySet::PropertySet ( const PropertySet )
virtual carto::PropertySet::~PropertySet ( )
virtual

Member Function Documentation

template<typename T >
void carto::PropertySet::addBuiltinProperty ( const std::string &  key,
T &  reference 
)

Definition at line 232 of file property.h.

References carto::Object::reference().

template<typename T >
void carto::PropertySet::addBuiltinProperty ( const std::string &  key,
T &  reference,
bool &  provided 
)

add an optional builtin property

Definition at line 246 of file property.h.

References carto::Object::reference().

virtual void carto::PropertySet::clearProperties ( )
virtual

clear the dictionary

Reimplemented from carto::DictionaryInterface.

virtual void carto::PropertySet::copyBuiltinProperties ( const PropertySet source)
virtual
PropertySet::iterator carto::PropertySet::getIterator ( ) const
inline

Definition at line 274 of file property.h.

template<typename T >
bool carto::PropertySet::getProperty ( const std::string &  key,
T &  value 
) const

Definition at line 261 of file property.h.

virtual bool carto::PropertySet::getProperty ( const std::string &  key,
Object value 
) const
virtual

Access the element ok key key.

value is filled with a wrapper to the selected element. If it fails (key not found for instance), an exception is thrown.

Implements carto::DictionaryInterface.

Signal& carto::PropertySet::getSignalPropertyChanged ( )
virtual bool carto::PropertySet::hasProperty ( const std::string &  key) const
virtual

check if an element exists under the key key

Implements carto::DictionaryInterface.

virtual Object carto::PropertySet::objectIterator ( ) const
virtual

returns an object implementing the IteratorIntrerface

Implements carto::IterableInterface.

PropertySet& carto::PropertySet::operator= ( const PropertySet )
virtual bool carto::PropertySet::removeProperty ( const std::string &  )
virtual

remove an element.

Note that on some dictionary implementations (PropertySet with builtin properties for instance), some properties cannot be removed.

Implements carto::DictionaryInterface.

template<typename T >
void carto::PropertySet::setProperty ( const std::string &  key,
const T &  value 
)

Definition at line 202 of file property.h.

References carto::Object::reference(), and carto::Object::value().

virtual void carto::PropertySet::setProperty ( const std::string &  key,
Object  value 
)
virtual

Set (insert or replace) the element of key key with the value object.

On some specific dictionary implementations (such as PropertySet with builtin properties, or maps of specific, typed values), an existing property cannot change type. In this case value must hold an object of the correct type, otherwise an exception will be thrown.

Implements carto::DictionaryInterface.

virtual size_t carto::PropertySet::size ( ) const
virtual

Number of sub-elements.

This method may throw an exception if the stored object has not a size-compatible interface

Implements carto::SizeInterface.


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