Tekkotsu Homepage | Demos | Overview | Downloads | Dev. Resources | Reference | Credits |
plist::DictionaryBase Class ReferenceMaintains a set of (key,value) pairs, see DictionaryOf, and the Dictionary typedef. More...
Inheritance diagram for plist::DictionaryBase:
Detailed DescriptionMaintains a set of (key,value) pairs, see DictionaryOf, and the Dictionary typedef. You can add or set entries by a quite a few variations on addEntry(), setEntry(), or addValue(). Basically these boil down to either:
Definition at line 269 of file plistCollections.h.
Member Typedef Documentation
shorthand for the type of comments Definition at line 474 of file plistCollections.h.
shorthand for iterators to be returned Reimplemented in InstanceTracker< FamilyT, ClassNameT, FactoryBaseT, FactoryT >. Definition at line 277 of file plistCollections.h.
shorthand for iterators to be returned Reimplemented in InstanceTracker< FamilyT, ClassNameT, FactoryBaseT, FactoryT >. Definition at line 275 of file plistCollections.h.
shorthand for the type of the storage Reimplemented in plist::DictionaryOf< PO, Alloc >, plist::DictionaryOf< SinusoidalParameters >, plist::DictionaryOf< plist::Primitive< float > >, plist::DictionaryOf< plist::Primitive< T > >, and plist::DictionaryOf< plist::Point >. Definition at line 273 of file plistCollections.h. Constructor & Destructor Documentation
constructor Definition at line 430 of file plistCollections.h.
copy constructor (don't assign listeners) Definition at line 432 of file plistCollections.h.
destructor Definition at line 437 of file plistCollections.h. Member Function Documentation
return an STL const_iterator to the first entry Reimplemented in PhysicsWorld, plist::DictionaryOf< PO, Alloc >, plist::DictionaryOf< SinusoidalParameters >, plist::DictionaryOf< plist::Primitive< float > >, plist::DictionaryOf< plist::Primitive< T > >, and plist::DictionaryOf< plist::Point >. Definition at line 399 of file plistCollections.h. Referenced by getLongestKeyLen(), loadXML(), plist::DictionaryOf< PO, Alloc >::set(), and XWalkMC::spiderSettings().
remove all entries in one fell swoop Implements plist::Collection. Reimplemented in ConvexPolyObstacle, HierarchicalObstacle, and plist::RGBColor< T >. Definition at line 614 of file plistCollections.cc. Referenced by Grasper::computeGoalStates(), and ~DictionaryBase().
called after an assignment or copy to clone the objects in myRef to perform a deep copy Definition at line 640 of file plistCollections.cc. Referenced by DictionaryBase().
return the one-past-end const_iterator Reimplemented in PhysicsWorld, plist::DictionaryOf< PO, Alloc >, plist::DictionaryOf< SinusoidalParameters >, plist::DictionaryOf< plist::Primitive< float > >, plist::DictionaryOf< plist::Primitive< T > >, and plist::DictionaryOf< plist::Point >. Definition at line 401 of file plistCollections.h. Referenced by getLongestKeyLen(), loadXML(), plist::DictionaryOf< PO, Alloc >::set(), and XWalkMC::spiderSettings().
returns an iterator to an entry in the current dictionary Reimplemented in plist::DictionaryOf< PO, Alloc >, plist::DictionaryOf< SinusoidalParameters >, plist::DictionaryOf< plist::Primitive< float > >, plist::DictionaryOf< plist::Primitive< T > >, and plist::DictionaryOf< plist::Point >. Definition at line 394 of file plistCollections.h. Referenced by saveOverXMLNode().
run through collectionListeners, calling CollectionListener::plistCollectionEntryRemoved(*this,val) Reimplemented from plist::Collection. Reimplemented in plist::RGBColor< T >. Definition at line 631 of file plistCollections.cc. Referenced by removeEntry(), and renameEntry().
returns comment retrieved from loaded file, or any subsequent call to setComment Definition at line 402 of file plistCollections.cc. Referenced by plist::DictionaryOf< PO, Alloc >::operator=(), and plist::DictionaryOf< PO, Alloc >::set().
returns a reference to the entry with the specified name, creating it if it doesn't exist Implemented in OutputConfig< T >, plist::DictionaryOf< PO, Alloc >, OutputConfig< plist::Primitive< float > >, plist::DictionaryOf< SinusoidalParameters >, plist::DictionaryOf< plist::Primitive< float > >, plist::DictionaryOf< plist::Primitive< T > >, and plist::DictionaryOf< plist::Point >.
returns the length of the longest key, subject to an optional regular expression and max depth Implements plist::Collection. Reimplemented in plist::RGBColor< T >. Definition at line 573 of file plistCollections.cc. Referenced by saveXML(), KinematicJoint::saveXML(), and OutputConfig< T >::saveXML().
returns an entry matching just the prefix
Definition at line 601 of file plistCollections.cc.
returns an entry matching just the prefix
Definition at line 589 of file plistCollections.cc. Referenced by resolveEntry().
This specialization looks for the SensorInfo::sensorType, then has the factory construct the correct subtype before loading the node into and returning that. From the name of node, will instantiate a new ObjectBase subclass to load it. supports use of plist::ArrayOf<PlannerObstacle> for polymorphic load/save The mapping from node names to actual instantiated types is:
If successful, returns a pointer to a newly allocated region, which the caller is responsible for freeing. If an error occurs, NULL is returned. attempts to load a new T instance from the specified xmlNode Reimplemented from plist::ObjectBase. Reimplemented in KinematicJoint, RectangularObstacle, CircularObstacle, EllipticalObstacle, ConvexPolyObstacle, BoxObstacle, CylindricalObstacle, SphericalObstacle, EllipsoidObstacle, InstanceTracker< FamilyT, ClassNameT, FactoryBaseT, FactoryT >, and plist::RGBColor< T >. Definition at line 411 of file plistCollections.cc. Referenced by plist::loadXML(), InstanceTracker< FamilyT, ClassNameT, FactoryBaseT, FactoryT >::loadXML(), and ConfigDictionary::loadXMLNode().
called with each node being loaded so subclass can handle appropriately Implemented in ConfigDictionary, OutputConfig< T >, plist::DictionaryOf< PO, Alloc >, OutputConfig< plist::Primitive< float > >, plist::DictionaryOf< SinusoidalParameters >, plist::DictionaryOf< plist::Primitive< float > >, plist::DictionaryOf< plist::Primitive< T > >, and plist::DictionaryOf< plist::Point >. Referenced by loadXML().
assignment (don't assign listeners) Definition at line 434 of file plistCollections.h.
returns a reference to the entry with the specified name, creating it if it doesn't exist Implemented in plist::DictionaryOf< PO, Alloc >, plist::DictionaryOf< SinusoidalParameters >, plist::DictionaryOf< plist::Primitive< float > >, plist::DictionaryOf< plist::Primitive< T > >, and plist::DictionaryOf< plist::Point >.
returns true if the specified object will be deallocated when removed from the dictionary Definition at line 426 of file plistCollections.h.
remove the entry with key name, returns true if something was actually removed (if false, wasn't there to begin with) Definition at line 291 of file plistCollections.cc. Referenced by plist::DictionaryOf< PO, Alloc >::addEntry(), InstanceTracker< FamilyT, ClassNameT, FactoryBaseT, FactoryT >::destroy(), loadXML(), EllipsoidObstacle::loadXML(), SphericalObstacle::loadXML(), CylindricalObstacle::loadXML(), BoxObstacle::loadXML(), ConvexPolyObstacle::loadXML(), EllipticalObstacle::loadXML(), CircularObstacle::loadXML(), RectangularObstacle::loadXML(), plist::DictionaryOf< PO, Alloc >::loadXMLNode(), plist::DictionaryOf< PO, Alloc >::operator=(), OdometrySensor::reclaimValues(), GPSSensor::reclaimValues(), SensorFeedback::reclaimValues(), SensorContact::reclaimValues(), SensorRangeFinder::reclaimValues(), plist::DictionaryOf< PO, Alloc >::set(), and plist::DictionaryOf< PO, Alloc >::setEntry().
change the key for an entry from oldname to newname, returns false if oldname didn't exist (thus no change was made) If the collection owns the reference to the object, you have to use this function instead of a pair of calls to removeEntry/addEntry, otherwise you will wind up with an invalid pointer! Definition at line 303 of file plistCollections.cc. Referenced by swapEntry().
returns a pointer to entry with the specified 'path', which may recurse through sub-collections Implements plist::Collection. Reimplemented in plist::RGBColor< T >. Definition at line 374 of file plistCollections.cc. Referenced by Config::parseLine(), Controller::setConfig(), and Config::setValue().
called with each node being saved so subclass can handle appropriately, return true if successful and reset key if changed Reimplemented in ConfigDictionary. Definition at line 671 of file plistCollections.cc. Referenced by saveXML().
saves the dictionary into the specified node
seen is not cleared before being used. Reimplemented in KinematicJoint, OutputConfig< T >, Config, and OutputConfig< plist::Primitive< float > >. Definition at line 485 of file plistCollections.cc.
subclasses are expected to provide a working implementation Implements plist::ObjectBase. Reimplemented in RectangularObstacle, CircularObstacle, EllipticalObstacle, ConvexPolyObstacle, BoxObstacle, CylindricalObstacle, SphericalObstacle, EllipsoidObstacle, and plist::RGBColor< T >. Definition at line 411 of file plistCollections.h. Referenced by ConfigDictionary::saveOverXMLNode(), saveXML(), EllipsoidObstacle::saveXML(), SphericalObstacle::saveXML(), CylindricalObstacle::saveXML(), BoxObstacle::saveXML(), ConvexPolyObstacle::saveXML(), EllipticalObstacle::saveXML(), CircularObstacle::saveXML(), and RectangularObstacle::saveXML().
called with each node being saved so subclass can handle appropriately, return true if successful and set key Definition at line 728 of file plistCollections.cc. Referenced by KinematicJoint::doSaveXMLNode(), saveXML(), and OutputConfig< T >::saveXML().
replaces previous comment for name, or adds it if it doesn't already exist (can preceed actual entry!) Definition at line 393 of file plistCollections.cc. Referenced by plist::DictionaryOf< PO, Alloc >::loadXMLNode(), plist::DictionaryOf< PO, Alloc >::operator=(), and plist::DictionaryOf< PO, Alloc >::set().
return the size of the dictionary Implements plist::Collection. Reimplemented in plist::RGBColor< T >. Definition at line 403 of file plistCollections.h. Referenced by ConfigurationEditor::getObjectTemplates(), loadXML(), plist::DictionaryOf< PO, Alloc >::operator=(), saveXML(), KinematicJoint::saveXML(), OutputConfig< T >::saveXML(), and plist::DictionaryOf< PO, Alloc >::set().
exchange the values for a pair of keys -- if either key doesn't exist, forwards call to renameEntry() returns true if the swap was successful, only returns false if both keys are invalid Definition at line 339 of file plistCollections.cc.
indicates that the storage implementation should mark this as an externally supplied heap reference, which needs to be deleted on removal/destruction Definition at line 627 of file plistCollections.cc. Referenced by plist::DictionaryOf< PO, Alloc >::addEntry(), and plist::DictionaryOf< PO, Alloc >::setEntry().
return current value as a string Implements plist::ObjectBase. Reimplemented in PlannerObstacle< N >, RectangularObstacle, CircularObstacle, EllipticalObstacle, ConvexPolyObstacle, HierarchicalObstacle, BoxObstacle, CylindricalObstacle, SphericalObstacle, EllipsoidObstacle, and plist::RGBColor< T >. Definition at line 567 of file plistCollections.cc. Friends And Related Function Documentation
provides textual output Definition at line 1578 of file plistCollections.h. Member Data Documentation
storage of entry comments -- mapping from keys to help text comments for manual editing or user feedback not every key necessarily has a comment! Definition at line 477 of file plistCollections.h. Referenced by plist::DictionaryOf< PO, Alloc >::addEntry(), clear(), getComment(), removeEntry(), renameEntry(), saveOverXMLNode(), saveXMLNode(), setComment(), and swapEntry().
storage of entries -- mapping from keys to value pointers Definition at line 468 of file plistCollections.h. Referenced by plist::DictionaryOf< PO, Alloc >::addEntry(), plist::DictionaryOf< plist::Point >::begin(), begin(), clear(), cloneMyRef(), plist::DictionaryOf< plist::Point >::end(), end(), plist::DictionaryOf< plist::Point >::findEntry(), findEntry(), getComment(), plist::DictionaryOf< plist::Point >::getEntry(), getSubEntry(), plist::DictionaryOf< PO, Alloc >::loadXMLNode(), plist::DictionaryOf< PO, Alloc >::operator=(), removeEntry(), renameEntry(), resolveEntry(), saveOverXMLNode(), saveXML(), OutputConfig< T >::saveXML(), plist::DictionaryOf< PO, Alloc >::set(), plist::DictionaryOf< PO, Alloc >::setEntry(), size(), and swapEntry().
objects which have been handed over to the collection for eventual de-allocation Definition at line 471 of file plistCollections.h. Referenced by plist::DictionaryOf< PO, Alloc >::addEntry(), clear(), cloneMyRef(), plist::RGBColor< T >::fireEntryRemoved(), fireEntryRemoved(), plist::DictionaryOf< PO, Alloc >::operator=(), ownsReference(), plist::DictionaryOf< PO, Alloc >::set(), plist::DictionaryOf< PO, Alloc >::setEntry(), and takeObject(). The documentation for this class was generated from the following files: |
Tekkotsu v5.1CVS |
Generated Mon May 9 04:59:24 2016 by Doxygen 1.6.3 |