plist::PrimitiveBase Class Reference
#include <plistBase.h>
Inheritance diagram for plist::PrimitiveBase:
Detailed Description
Provides common functionality to all primitive value classes (implemented in a templated subclass Primitive).This class supports callbacks upon modification through the use of the PrimitiveListener interface. Note that we only store a pointer to the listener list, which is typically unallocated when no listeners are active. This should ensure minimal memory usage per object, as well as support safe storage of plist objects in inter-process shared memory regions.
If you are using these in a shared memory region, just be sure that only the process with listeners does any and all modifications, and that it unsubscribes before detaching from the region (or else destroys the region itself)
Definition at line 175 of file plistBase.h.
Public Member Functions | |
| PrimitiveBase () | |
| constructor | |
| PrimitiveBase (const PrimitiveBase &pb) | |
| copy constructor (don't copy listeners) | |
| PrimitiveBase & | operator= (const PrimitiveBase &pb) |
| assignment (don't assign listeners) | |
| ~PrimitiveBase () | |
| destructor | |
| virtual void | set (const std::string &str)=0 |
| assign a new value | |
| virtual std::string | get () const =0 |
| return current value as a string | |
| virtual std::string | toString () const |
| return current value as a string | |
| virtual void | addPrimitiveListener (PrimitiveListener *vl) |
| get notified of changes; be sure to call removeValueListener before destructing vl! | |
| virtual void | removePrimitiveListener (PrimitiveListener *vl) |
| no longer take notification of changes to this object's value | |
| virtual bool | isPrimitiveListener (PrimitiveListener *vl) |
| test if l is currently registered as a listener | |
Protected Member Functions | |
| virtual void | fireValueChanged () const |
| run through primitiveListeners, calling PrimitiveListener::plistValueChanged(*this) | |
Protected Attributes | |
| std::list< PrimitiveListener * > * | primitiveListeners |
| stores a list of the current listeners | |
Constructor & Destructor Documentation
| plist::PrimitiveBase::PrimitiveBase | ( | ) | [inline] |
| plist::PrimitiveBase::PrimitiveBase | ( | const PrimitiveBase & | pb | ) | [inline] |
| plist::PrimitiveBase::~PrimitiveBase | ( | ) |
Member Function Documentation
| void plist::PrimitiveBase::addPrimitiveListener | ( | PrimitiveListener * | vl | ) | [virtual] |
get notified of changes; be sure to call removeValueListener before destructing vl!
Definition at line 86 of file plistBase.cc.
| void plist::PrimitiveBase::fireValueChanged | ( | ) | const [protected, virtual] |
run through primitiveListeners, calling PrimitiveListener::plistValueChanged(*this)
Definition at line 113 of file plistBase.cc.
Referenced by plist::Primitive< std::string >::loadXML(), plist::Primitive< unsigned char >::loadXML(), plist::Primitive< char >::loadXML(), plist::Primitive< unsigned char >::operator *=(), plist::Primitive< char >::operator *=(), plist::Primitive< T >::operator *=(), plist::Primitive< unsigned char >::operator+=(), plist::Primitive< char >::operator+=(), plist::Primitive< T >::operator+=(), plist::Primitive< unsigned char >::operator-=(), plist::Primitive< char >::operator-=(), plist::Primitive< T >::operator-=(), plist::Primitive< unsigned char >::operator/=(), plist::Primitive< char >::operator/=(), plist::Primitive< T >::operator/=(), plist::NamedEnumeration< T >::operator=(), plist::Primitive< std::string >::operator=(), plist::Primitive< unsigned char >::operator=(), plist::Primitive< char >::operator=(), plist::Primitive< T >::operator=(), operator=(), plist::NamedEnumeration< T >::set(), plist::Primitive< unsigned char >::set(), and plist::Primitive< char >::set().
| virtual std::string plist::PrimitiveBase::get | ( | ) | const [pure virtual] |
return current value as a string
Implemented in plist::Primitive< char >, plist::Primitive< unsigned char >, plist::Primitive< std::string >, and plist::NamedEnumeration< T >.
Referenced by plist::operator<<(), and toString().
| bool plist::PrimitiveBase::isPrimitiveListener | ( | PrimitiveListener * | vl | ) | [virtual] |
| PrimitiveBase& plist::PrimitiveBase::operator= | ( | const PrimitiveBase & | pb | ) | [inline] |
assignment (don't assign listeners)
Definition at line 182 of file plistBase.h.
Referenced by plist::NamedEnumeration< T >::operator=().
| void plist::PrimitiveBase::removePrimitiveListener | ( | PrimitiveListener * | vl | ) | [virtual] |
no longer take notification of changes to this object's value
Definition at line 93 of file plistBase.cc.
| virtual void plist::PrimitiveBase::set | ( | const std::string & | str | ) | [pure virtual] |
assign a new value
Implemented in plist::Primitive< char >, plist::Primitive< unsigned char >, plist::Primitive< std::string >, and plist::NamedEnumeration< T >.
Referenced by plist::Primitive< unsigned char >::loadXML(), plist::Primitive< char >::loadXML(), and plist::operator>>().
| virtual std::string plist::PrimitiveBase::toString | ( | ) | const [inline, virtual] |
return current value as a string
Implements plist::ObjectBase.
Definition at line 191 of file plistBase.h.
Member Data Documentation
std::list<PrimitiveListener*>* plist::PrimitiveBase::primitiveListeners [protected] |
stores a list of the current listeners
Definition at line 204 of file plistBase.h.
Referenced by addPrimitiveListener(), fireValueChanged(), isPrimitiveListener(), removePrimitiveListener(), and ~PrimitiveBase().
The documentation for this class was generated from the following files:
