Tekkotsu Homepage | Demos | Overview | Downloads | Dev. Resources | Reference | Credits |
plist::ArrayBase Class Reference#include <plistCollections.h>
Inheritance diagram for plist::ArrayBase:
![]() Detailed DescriptionMaintains an array of value, see ArrayOf, and the Array 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 811 of file plistCollections.h.
Member Typedef Documentation
shorthand for the type of the storage
Reimplemented in plist::ArrayOf< PO, Alloc >, and plist::ArrayOf< plist::Primitive< std::string > >. Definition at line 815 of file plistCollections.h.
Constructor & Destructor Documentation
Member Function Documentation
remove the entry at position index, returns true if something was actually removed (if false, wasn't there to begin with)
Definition at line 541 of file plistCollections.cc. Referenced by loadXML().
return the value at position index, which must exist (no range checking)
Reimplemented in plist::ArrayOf< PO, Alloc >, and plist::ArrayOf< plist::Primitive< std::string > >. Definition at line 966 of file plistCollections.h. Referenced by resolveEntry().
return the value at position index, which must exist (no range checking, equivalent to getEntry(index))
Reimplemented in plist::ArrayOf< PO, Alloc >, and plist::ArrayOf< plist::Primitive< std::string > >. Definition at line 968 of file plistCollections.h.
recursively resolves path interpreted as a series of collection entry names separated by '.', returns NULL if it doesn't exist
Implements plist::Collection. Definition at line 553 of file plistCollections.cc.
remove all entries in one fell swoop
Implements plist::Collection. Definition at line 565 of file plistCollections.cc.
return an STL const_iterator to the first entry
Reimplemented in plist::ArrayOf< PO, Alloc >, and plist::ArrayOf< plist::Primitive< std::string > >. Definition at line 974 of file plistCollections.h.
return the one-past-end const_iterator
Reimplemented in plist::ArrayOf< PO, Alloc >, and plist::ArrayOf< plist::Primitive< std::string > >. Definition at line 976 of file plistCollections.h.
return the size of the array
Implements plist::Collection. Definition at line 978 of file plistCollections.h. Referenced by plist::ArrayOf< PO, Alloc >::addEntry(), getLongestKeyLen(), getSubEntry(), Kinematics::init(), Kinematics::initStatics(), loadXML(), plist::ArrayOf< PO, Alloc >::loadXMLNode(), Kinematics::newChain(), plist::ArrayOf< PO, Alloc >::operator=(), resolveEntry(), saveXML(), plist::ArrayOf< PO, Alloc >::set(), and plist::ArrayOf< PO, Alloc >::setEntry().
replaces previous comment for name, or adds it if it doesn't already exist (can preceed actual entry!)
Definition at line 578 of file plistCollections.cc. Referenced by plist::ArrayOf< PO, Alloc >::addEntry(), plist::ArrayOf< PO, Alloc >::loadXMLNode(), plist::ArrayOf< PO, Alloc >::operator=(), and plist::ArrayOf< PO, Alloc >::set().
returns comment retrieved from loaded file, or any subsequent call to setComment
Definition at line 585 of file plistCollections.cc. Referenced by plist::ArrayOf< PO, Alloc >::operator=(), and plist::ArrayOf< PO, Alloc >::set().
From the name of node, will instantiate a new ObjectBase subclass to load it. 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. Reimplemented from plist::ObjectBase. Definition at line 593 of file plistCollections.cc.
subclasses are expected to provide a working implementation
Implements plist::ObjectBase. Definition at line 612 of file plistCollections.cc.
return current value as a string
Implements plist::ObjectBase. Definition at line 716 of file plistCollections.cc.
returns longest key length which matches the regular expression
Implements plist::Collection. Definition at line 722 of file plistCollections.cc.
returns true if the specified object will be deallocated when removed from the array
Definition at line 993 of file plistCollections.h. Referenced by plist::ArrayOf< PO, Alloc >::operator=(), and plist::ArrayOf< PO, Alloc >::set(). assignment
Definition at line 1001 of file plistCollections.h. Referenced by plist::ArrayOf< PO, Alloc >::operator=(), and plist::ArrayOf< PO, Alloc >::set().
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 740 of file plistCollections.cc. Referenced by plist::ArrayOf< PO, Alloc >::addEntry(), and plist::ArrayOf< PO, Alloc >::setEntry().
run through collectionListeners, calling CollectionListener::plistCollectionEntryRemoved(*this,val)
Reimplemented from plist::Collection. Definition at line 744 of file plistCollections.cc. Referenced by removeEntry().
returns an entry matching just the prefix
Definition at line 753 of file plistCollections.cc. Referenced by resolveEntry().
returns an entry matching just the prefix
Definition at line 767 of file plistCollections.cc.
called after an assignment or copy to clone the objects in myRef to perform a deep copy
Definition at line 782 of file plistCollections.cc.
called by loadXML(), loads a single xmlNode into a specified position, replacing previous entry if it can't accept the new value (subject to the load/save policy...)
Implemented in plist::ArrayOf< PO, Alloc >, and plist::ArrayOf< plist::Primitive< std::string > >. Referenced by loadXML().
Friends And Related Function Documentation
Member Data Documentation
storage of entries
Definition at line 1029 of file plistCollections.h. Referenced by plist::ArrayOf< PO, Alloc >::addEntry(), clear(), cloneMyRef(), getLongestKeyLen(), getSubEntry(), plist::ArrayOf< PO, Alloc >::loadXMLNode(), plist::ArrayOf< PO, Alloc >::operator=(), removeEntry(), resolveEntry(), saveXML(), plist::ArrayOf< PO, Alloc >::set(), and plist::ArrayOf< PO, Alloc >::setEntry().
objects which have been handed over to the collection for eventual de-allocation
Definition at line 1032 of file plistCollections.h. Referenced by clear(), cloneMyRef(), fireEntryRemoved(), plist::ArrayOf< PO, Alloc >::operator=(), plist::ArrayOf< PO, Alloc >::set(), plist::ArrayOf< PO, Alloc >::setEntry(), and takeObject().
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 1038 of file plistCollections.h. Referenced by clear(), getComment(), removeEntry(), saveXML(), and setComment().
The documentation for this class was generated from the following files: |
Tekkotsu v4.0 |
Generated Thu Nov 22 00:58:55 2007 by Doxygen 1.5.4 |