plist::PrimitiveBase Class Reference
Provides common functionality to all primitive value classes (implemented in a templated subclass Primitive). More...
#include <plistBase.h>
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 245 of file plistBase.h.
Public Member Functions | |
| PrimitiveBase () | |
| constructor | |
| PrimitiveBase (const PrimitiveBase &pb) | |
| copy constructor (don't copy listeners) | |
| virtual PrimitiveBase & | operator= (const PrimitiveBase &pb) |
| assignment (don't assign listeners); doesn't trigger fireValueChanged, subclass should do that from its own operator=() following assignment | |
| PrimitiveBase & | operator= (const Primitive< std::string > &v) |
| assignment from Primitive<string>, solely to resolve ambiguity with this type between operator=(PrimitiveBase) and operator=(std::string) | |
| PrimitiveBase & | operator= (const std::string &v) |
| assignment from std::string, wraps it in a plist::Primitive and passes on to operator=(PrimitiveBase) | |
| PrimitiveBase & | operator= (long v) |
| assignment from long value, wraps it in a plist::Primitive and passes on to operator=(PrimitiveBase) | |
| PrimitiveBase & | operator= (unsigned long v) |
| assignment from unsigned long value, wraps it in a plist::Primitive and passes on to operator=(PrimitiveBase) | |
| PrimitiveBase & | operator= (double v) |
| assignment from double value, wraps it in a plist::Primitive and passes on to operator=(PrimitiveBase) | |
| ~PrimitiveBase () | |
| destructor | |
| virtual void | set (const std::string &str)=0 |
| assign a new value | |
| virtual void | set (const ObjectBase &ob) |
| polymorphic assignment (throws std::bad_cast if the assignment is between invalid types, i.e. a primitive and a collection, or different collection types) | |
| virtual std::string | get () const =0 |
| return current value as a string | |
| virtual bool | operator== (const PrimitiveBase &other)=0 |
| virtual std::string | toString () const |
| return current value as a string | |
| virtual void | addPrimitiveListener (PrimitiveListener *vl) const |
| get notified of changes; be sure to call removeValueListener before destructing vl! | |
| virtual void | removePrimitiveListener (PrimitiveListener *vl) const |
| no longer take notification of changes to this object's value | |
| virtual bool | isPrimitiveListener (PrimitiveListener *vl) const |
| test if l is currently registered as a listener | |
Protected Member Functions | |
| virtual void | fireValueChanged (bool touch) const |
| run through primitiveListeners, calling PrimitiveListener::plistValueChanged(*this) or PrimitiveListener::plistValueTouched(*this) | |
Protected Attributes | |
| std::set< PrimitiveListener * > * | primitiveListeners |
| stores a list of the current listeners | |
Constructor & Destructor Documentation
| plist::PrimitiveBase::PrimitiveBase | ( | ) |
constructor
Definition at line 248 of file plistBase.h.
| plist::PrimitiveBase::PrimitiveBase | ( | const PrimitiveBase & | pb | ) |
copy constructor (don't copy listeners)
Definition at line 250 of file plistBase.h.
| plist::PrimitiveBase::~PrimitiveBase | ( | ) |
destructor
Definition at line 112 of file plistBase.cc.
Member Function Documentation
| void plist::PrimitiveBase::addPrimitiveListener | ( | PrimitiveListener * | vl | ) | const [virtual] |
get notified of changes; be sure to call removeValueListener before destructing vl!
Definition at line 117 of file plistBase.cc.
Referenced by KinematicJoint::addSelfListener(), KinematicJoint::getIK(), and XWalkMC::ParameterTransition::ParameterTransition().
| void plist::PrimitiveBase::fireValueChanged | ( | bool | touch | ) | const [protected, virtual] |
run through primitiveListeners, calling PrimitiveListener::plistValueChanged(*this) or PrimitiveListener::plistValueTouched(*this)
Definition at line 144 of file plistBase.cc.
Referenced by plist::Angle::loadXML(), plist::OutputSelector::loadXML(), plist::Primitive< bool >::operator*=(), plist::Primitive< bool >::operator+=(), plist::Primitive< bool >::operator-=(), plist::Primitive< bool >::operator/=(), plist::OutputSelector::operator=(), plist::Primitive< bool >::operator=(), plist::Angle::set(), plist::OutputSelector::set(), and plist::OutputSelector::setRange().
| virtual std::string plist::PrimitiveBase::get | ( | ) | const [pure virtual] |
return current value as a string
Implemented in plist::Primitive< T >, plist::NamedEnumeration< T >, plist::OutputSelector, plist::Angle, plist::Primitive< fmat::fmatReal >, plist::Primitive< PLISTREAL >, plist::Primitive< std::string >, plist::Primitive< float >, plist::Primitive< int >, plist::Primitive< unsigned int >, plist::Primitive< unsigned short >, plist::Primitive< string >, plist::Primitive< storage_t >, plist::Primitive< bool >, plist::NamedEnumeration< Config::vision_config::encoding_t >, plist::NamedEnumeration< J_DCT_METHOD >, plist::NamedEnumeration< Config::transports >, plist::NamedEnumeration< gain_levels >, plist::NamedEnumeration< volume_levels >, plist::NamedEnumeration< compression_t >, plist::NamedEnumeration< white_balance_levels >, plist::NamedEnumeration< consoleMode_t >, plist::NamedEnumeration< JointType_t >, and plist::NamedEnumeration< shutter_speeds >.
Referenced by plist::operator<<().
| bool plist::PrimitiveBase::isPrimitiveListener | ( | PrimitiveListener * | vl | ) | const [virtual] |
test if l is currently registered as a listener
Definition at line 136 of file plistBase.cc.
| PrimitiveBase & plist::PrimitiveBase::operator= | ( | double | v | ) |
assignment from double value, wraps it in a plist::Primitive and passes on to operator=(PrimitiveBase)
Definition at line 110 of file plistBase.cc.
| PrimitiveBase & plist::PrimitiveBase::operator= | ( | unsigned long | v | ) |
assignment from unsigned long value, wraps it in a plist::Primitive and passes on to operator=(PrimitiveBase)
Definition at line 109 of file plistBase.cc.
| PrimitiveBase & plist::PrimitiveBase::operator= | ( | long | v | ) |
assignment from long value, wraps it in a plist::Primitive and passes on to operator=(PrimitiveBase)
Definition at line 108 of file plistBase.cc.
| PrimitiveBase & plist::PrimitiveBase::operator= | ( | const std::string & | v | ) |
assignment from std::string, wraps it in a plist::Primitive and passes on to operator=(PrimitiveBase)
Reimplemented in plist::NamedEnumerationBase, plist::NamedEnumeration< T >, plist::OutputSelector, plist::Angle, plist::Primitive< std::string >, plist::NamedEnumeration< Config::vision_config::encoding_t >, plist::NamedEnumeration< J_DCT_METHOD >, plist::NamedEnumeration< Config::transports >, plist::NamedEnumeration< gain_levels >, plist::NamedEnumeration< volume_levels >, plist::NamedEnumeration< compression_t >, plist::NamedEnumeration< white_balance_levels >, plist::NamedEnumeration< consoleMode_t >, plist::NamedEnumeration< JointType_t >, and plist::NamedEnumeration< shutter_speeds >.
Definition at line 107 of file plistBase.cc.
| PrimitiveBase & plist::PrimitiveBase::operator= | ( | const Primitive< std::string > & | v | ) |
assignment from Primitive<string>, solely to resolve ambiguity with this type between operator=(PrimitiveBase) and operator=(std::string)
Definition at line 106 of file plistBase.cc.
| virtual PrimitiveBase& plist::PrimitiveBase::operator= | ( | const PrimitiveBase & | pb | ) | [virtual] |
assignment (don't assign listeners); doesn't trigger fireValueChanged, subclass should do that from its own operator=() following assignment
Reimplemented in plist::Primitive< T >, plist::NamedEnumerationBase, plist::NamedEnumeration< T >, plist::Primitive< fmat::fmatReal >, plist::Primitive< PLISTREAL >, plist::Primitive< std::string >, plist::Primitive< float >, plist::Primitive< int >, plist::Primitive< unsigned int >, plist::Primitive< unsigned short >, plist::Primitive< string >, plist::Primitive< storage_t >, plist::Primitive< bool >, plist::NamedEnumeration< Config::vision_config::encoding_t >, plist::NamedEnumeration< J_DCT_METHOD >, plist::NamedEnumeration< Config::transports >, plist::NamedEnumeration< gain_levels >, plist::NamedEnumeration< volume_levels >, plist::NamedEnumeration< compression_t >, plist::NamedEnumeration< white_balance_levels >, plist::NamedEnumeration< consoleMode_t >, plist::NamedEnumeration< JointType_t >, and plist::NamedEnumeration< shutter_speeds >.
Definition at line 252 of file plistBase.h.
| virtual bool plist::PrimitiveBase::operator== | ( | const PrimitiveBase & | other | ) | [pure virtual] |
Implemented in plist::Primitive< T >, plist::NamedEnumeration< T >, plist::Primitive< fmat::fmatReal >, plist::Primitive< PLISTREAL >, plist::Primitive< std::string >, plist::Primitive< float >, plist::Primitive< int >, plist::Primitive< unsigned int >, plist::Primitive< unsigned short >, plist::Primitive< string >, plist::Primitive< storage_t >, plist::Primitive< bool >, plist::NamedEnumeration< Config::vision_config::encoding_t >, plist::NamedEnumeration< J_DCT_METHOD >, plist::NamedEnumeration< Config::transports >, plist::NamedEnumeration< gain_levels >, plist::NamedEnumeration< volume_levels >, plist::NamedEnumeration< compression_t >, plist::NamedEnumeration< white_balance_levels >, plist::NamedEnumeration< consoleMode_t >, plist::NamedEnumeration< JointType_t >, and plist::NamedEnumeration< shutter_speeds >.
| void plist::PrimitiveBase::removePrimitiveListener | ( | PrimitiveListener * | vl | ) | const [virtual] |
no longer take notification of changes to this object's value
Definition at line 124 of file plistBase.cc.
Referenced by KinematicJoint::plistValueChanged(), KinematicJoint::removeSelfListener(), and XWalkMC::ParameterTransition::~ParameterTransition().
| virtual void plist::PrimitiveBase::set | ( | const ObjectBase & | ) | [virtual] |
polymorphic assignment (throws std::bad_cast if the assignment is between invalid types, i.e. a primitive and a collection, or different collection types)
Implements plist::ObjectBase.
Definition at line 268 of file plistBase.h.
| virtual void plist::PrimitiveBase::set | ( | const std::string & | str | ) | [pure virtual] |
assign a new value
Implemented in plist::Primitive< T >, plist::NamedEnumeration< T >, plist::OutputSelector, plist::Angle, plist::Primitive< fmat::fmatReal >, plist::Primitive< PLISTREAL >, plist::Primitive< std::string >, plist::Primitive< float >, plist::Primitive< int >, plist::Primitive< unsigned int >, plist::Primitive< unsigned short >, plist::Primitive< string >, plist::Primitive< storage_t >, plist::Primitive< bool >, plist::NamedEnumeration< Config::vision_config::encoding_t >, plist::NamedEnumeration< J_DCT_METHOD >, plist::NamedEnumeration< Config::transports >, plist::NamedEnumeration< gain_levels >, plist::NamedEnumeration< volume_levels >, plist::NamedEnumeration< compression_t >, plist::NamedEnumeration< white_balance_levels >, plist::NamedEnumeration< consoleMode_t >, plist::NamedEnumeration< JointType_t >, and plist::NamedEnumeration< shutter_speeds >.
Referenced by plist::operator>>(), ConfigurationEditor::refresh(), and Controller::setConfig().
| virtual std::string plist::PrimitiveBase::toString | ( | ) | const [virtual] |
return current value as a string
Implements plist::ObjectBase.
Definition at line 274 of file plistBase.h.
Member Data Documentation
std::set<PrimitiveListener*>* plist::PrimitiveBase::primitiveListeners [mutable, protected] |
stores a list of the current listeners
Definition at line 287 of file plistBase.h.
Referenced by addPrimitiveListener(), fireValueChanged(), isPrimitiveListener(), removePrimitiveListener(), and ~PrimitiveBase().
The documentation for this class was generated from the following files:
