|
PTLib
Version 2.18.8
|
|
PTLib
Version 2.18.8
|
This is a dictionary collection class of ordinals keyed by PString objects.
More...
#include <pstring.h>
Classes | |
| struct | Initialiser |
| Structure for static array initialiser for class. More... | |
Public Member Functions | |
Construction | |
| PStringToOrdinal (PINDEX count, const Initialiser *init, PBoolean caseless=false) | |
| Initialise the string dictionary of ordinals from the static array. More... | |
| PStringToOrdinal (PINDEX count, const POrdinalToString::Initialiser *init, PBoolean caseless=false) | |
| Initialise the string dictionary of ordinals from the static array. More... | |
Overrides from class PObject | |
| virtual void | ReadFrom (istream &strm) |
| Input the contents of the object from the stream. More... | |
 Public Member Functions inherited from POrdinalDictionary< K > | |
| POrdinalDictionary () | |
| Create a new, empty, dictionary. More... | |
| virtual PObject * | Clone () const |
| Make a complete duplicate of the dictionary. More... | |
| PINDEX | operator[] (const K &key) const |
Get the object contained in the dictionary at the key position. More... | |
| virtual PBoolean | SetDataAt (PINDEX index, PINDEX ordinal) |
| Set the data at the specified ordinal index position in the dictionary. More... | |
| virtual PBoolean | SetAt (const K &key, PINDEX ordinal) |
| Add a new object to the collection. More... | |
| const K & | GetKeyAt (PINDEX index) const |
| Get the key in the dictionary at the ordinal index position. More... | |
| PINDEX | GetDataAt (PINDEX index) const |
| Get the data in the dictionary at the ordinal index position. More... | |
| Public Member Functions inherited from PDictionary< K, POrdinalKey > | |
| PDictionary () | |
| Create a new, empty, dictionary. More... | |
| const POrdinalKey & | operator[] (const K &key) const |
Get the object contained in the dictionary at the key position. More... | |
| POrdinalKey & | operator[] (const K &key) |
| PBoolean | Contains (const K &key) const |
| Determine if the value of the object is contained in the hash table. More... | |
| virtual POrdinalKey * | RemoveAt (const K &key) |
Remove an object at the specified key. More... | |
| virtual PBoolean | SetAt (const K &key, POrdinalKey *obj) |
| Add a new object to the collection. More... | |
| virtual POrdinalKey * | GetAt (const K &key) const |
| Get the object at the specified key position. More... | |
| const K & | GetKeyAt (PINDEX index) const |
| Get the key in the dictionary at the ordinal index position. More... | |
| POrdinalKey & | GetDataAt (PINDEX index) const |
| Get the data in the dictionary at the ordinal index position. More... | |
| PArray< K > | GetKeys () const |
| Get an array containing all the keys for the dictionary. More... | |
| iterator | begin () |
| const_iterator | begin () const |
| iterator | end () |
| const_iterator | end () const |
| iterator | find (const K &key) |
| const_iterator | find (const K &k) const |
| void | erase (const iterator &it) |
| void | erase (const const_iterator &it) |
| Public Member Functions inherited from PAbstractDictionary | |
| PINLINE | PAbstractDictionary () |
| Create a new, empty, dictionary. More... | |
| virtual void | PrintOn (ostream &strm) const |
| Output the contents of the object to the stream. More... | |
| virtual PINDEX | Insert (const PObject &key, PObject *obj) |
| Insert a new object into the dictionary. More... | |
| virtual PINDEX | InsertAt (PINDEX index, PObject *obj) |
| Insert a new object at the specified index. More... | |
| virtual PObject * | RemoveAt (PINDEX index) |
| Remove an object at the specified index. More... | |
| virtual PBoolean | SetAt (PINDEX index, PObject *val) |
| Set the object at the specified index to the new value. More... | |
| virtual PObject * | GetAt (PINDEX index) const |
| Get the object at the specified index position. More... | |
| virtual PINDEX | GetObjectsIndex (const PObject *obj) const |
| Search the collection for the specific instance of the object. More... | |
| virtual PINDEX | GetValuesIndex (const PObject &obj) const |
| Search the collection for the specified value of the object. More... | |
| virtual P_DEPRECATED PBoolean | SetDataAt (PINDEX index, PObject *obj) |
| Set the data at the specified ordinal index position in the dictionary. More... | |
| virtual PObject * | AbstractSetAt (const PObject &key, PObject *obj) |
| Add a new object to the collection. More... | |
| virtual PObject & | GetRefAt (const PObject &key) const |
| Get the object at the specified key position. More... | |
| virtual PObject * | AbstractGetAt (const PObject &key) const |
| Get the object at the specified key position. More... | |
| virtual void | AbstractGetKeys (PArrayObjects &keys) const |
| Get an array containing all the keys for the dictionary. More... | |
| Public Member Functions inherited from PHashTable | |
| PHashTable () | |
| Create a new, empty, hash table. More... | |
| virtual Comparison | Compare (const PObject &obj) const |
| Get the relative rank of the two hash tables. More... | |
| virtual PBoolean | SetSize (PINDEX newSize) |
| This function is meaningless for hash table. More... | |
| PINLINE PBoolean | AbstractContains (const PObject &key) const |
| Determine if the value of the object is contained in the hash table. More... | |
| virtual const PObject & | AbstractGetKeyAt (PINDEX index) const |
| Get the key in the hash table at the ordinal index position. More... | |
| virtual PObject & | AbstractGetDataAt (PINDEX index) const |
| Get the data in the hash table at the ordinal index position. More... | |
| Public Member Functions inherited from PCollection | |
| PCollection (PINDEX initialSize=0) | |
| Create a new collection. More... | |
| virtual void | PrintOn (ostream &strm) const |
| Print the collection on the stream. More... | |
| __inline void | remove (const PObject *obj) |
| virtual void | RemoveAll () |
| Remove all of the elements in the collection. More... | |
| __inline void | clear () |
| PINLINE void | AllowDeleteObjects (PBoolean yes=true) |
| Allow or disallow the deletion of the objects contained in the collection. More... | |
| void | DisallowDeleteObjects () |
| Disallow the deletion of the objects contained in the collection. More... | |
| Public Member Functions inherited from PContainer | |
| PContainer (PINDEX initialSize=0) | |
| Create a new unique container. More... | |
| PContainer (const PContainer &cont) | |
| Create a new refernce to container. More... | |
| PContainer & | operator= (const PContainer &cont) |
| Assign one container reference to another. More... | |
| virtual | ~PContainer () |
| Destroy the container class. More... | |
| virtual PINDEX | GetSize () const |
| Get the current size of the container. More... | |
| __inline size_t | size () const |
| PBoolean | SetMinSize (PINDEX minSize) |
| Set the minimum size of container. More... | |
| virtual PBoolean | IsEmpty () const |
| Determine if the container is empty. More... | |
| __inline bool | empty () const |
| PBoolean | IsUnique () const |
| Determine if container is unique reference. More... | |
| virtual PBoolean | MakeUnique () |
| Make this instance to be the one and only reference to the container contents. More... | |
| Public Member Functions inherited from PObject | |
| __inline unsigned | GetTraceContextIdentifier () const |
| Get PTRACE context identifier. More... | |
| __inline void | SetTraceContextIdentifier (unsigned id) |
| __inline void | SetTraceContextIdentifier (const PObject &obj) |
| __inline void | SetTraceContextIdentifier (const PObject *obj) |
| __inline void | CopyTraceContextIdentifier (PObject &obj) const |
| __inline void | CopyTraceContextIdentifier (PObject *obj) const |
| virtual | ~PObject () |
| __inline const char * | GetClass () const |
| __inline bool | IsClass (const char *name) const |
| __inline const PObject * | PTraceObjectInstance () const |
| template<class CLS > | |
| CLS * | CloneAs () const |
| As for Clone() but converts to specified type. More... | |
| virtual PINDEX | HashFunction () const |
This function yields a hash value required by the PDictionary class. More... | |
| virtual Comparison | CompareObjectMemoryDirect (const PObject &obj) const |
| Determine the byte wise comparison of two objects. More... | |
| bool | operator== (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator!= (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator< (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator> (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator<= (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator>= (const PObject &obj) const |
| Compare the two objects. More... | |
| virtual void | ReadFrom (istream &strm) |
| Input the contents of the object from the stream. More... | |
Additional Inherited Members | |
| Public Types inherited from PDictionary< K, POrdinalKey > | |
| typedef K | key_type |
| typedef POrdinalKey | data_type |
| typedef PDictionary< K, POrdinalKey > | dict_type |
| Public Types inherited from PObject | |
| enum | Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 } |
Result of the comparison operation performed by the Compare() function. More... | |
| Static Public Member Functions inherited from PObject | |
| static __inline void | CopyTraceContextIdentifier (PObject &to, const PObject &from) |
| static __inline void | CopyTraceContextIdentifier (PObject &to, const PObject *from) |
| static __inline void | CopyTraceContextIdentifier (PObject *to, const PObject &from) |
| static __inline void | CopyTraceContextIdentifier (PObject *to, const PObject *from) |
| static __inline const char * | Class () |
| static __inline const PObject * | PTraceObjectInstance (const char *) |
| static __inline const PObject * | PTraceObjectInstance (const PObject *obj) |
| template<typename T > | |
| static Comparison | Compare2 (T v1, T v2) |
| Compare two types, returning Comparison type. More... | |
| static Comparison | InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size) |
| Internal function caled from CompareObjectMemoryDirect() More... | |
| Public Attributes inherited from PHashTable | |
| PHashTableInfo * | hashTable |
| Protected Member Functions inherited from POrdinalDictionary< K > | |
| POrdinalDictionary (int dummy, const POrdinalDictionary *c) | |
| Protected Member Functions inherited from PDictionary< K, POrdinalKey > | |
| PDictionary (int dummy, const PDictionary *c) | |
| Protected Member Functions inherited from PAbstractDictionary | |
| PINLINE | PAbstractDictionary (int dummy, const PAbstractDictionary *c) |
| Protected Member Functions inherited from PCollection | |
| PINLINE | PCollection (int dummy, const PCollection *coll) |
| Constructor used in support of the Clone() function. More... | |
| Protected Member Functions inherited from PContainer | |
| PContainer (int dummy, const PContainer *cont) | |
| Constructor used in support of the Clone() function. More... | |
| PContainer (PContainerReference &reference) | |
| Construct using static PContainerReference. More... | |
| virtual void | DestroyContents ()=0 |
| Destroy the container contents. More... | |
| virtual void | AssignContents (const PContainer &c) |
| Copy the container contents. More... | |
| void | CopyContents (const PContainer &c) |
| Copy the container contents. More... | |
| void | CloneContents (const PContainer *src) |
| Create a duplicate of the container contents. More... | |
| void | Destruct () |
| Internal function called from container destructors. More... | |
| virtual void | DestroyReference () |
| Destroy the PContainerReference instance. More... | |
| Protected Member Functions inherited from PObject | |
| PObject () | |
| Constructor for PObject, made protected so cannot ever create one on its own. More... | |
| Protected Attributes inherited from PContainer | |
| PContainerReference * | reference |
| Protected Attributes inherited from PObject | |
| unsigned | m_traceContextIdentifier |
This is a dictionary collection class of ordinals keyed by PString objects.
It has all the usual functions for a collection, with the object types set to POrdinalKey pointers.
In addition some addition functions are added that take a const POrdinalKey reference or a simple PINDEX instead of a pointer as most standard collection functions do. This is more convenient for when integer expressions are used as parameters to function in the collection.
See the PAbstractDicionary and POrdinalDictionary classes for more information.
| PStringToOrdinal::PStringToOrdinal | ( | PINDEX | count, |
| const Initialiser * | init, | ||
| PBoolean | caseless = false |
||
| ) |
Initialise the string dictionary of ordinals from the static array.
| count | Count of strings in initialiser array |
| init | Array of Initialiser structures |
| caseless | New keys are to be PCaselessStrings |
| PStringToOrdinal::PStringToOrdinal | ( | PINDEX | count, |
| const POrdinalToString::Initialiser * | init, | ||
| PBoolean | caseless = false |
||
| ) |
Initialise the string dictionary of ordinals from the static array.
| count | Count of strings in initialiser array |
| init | Array of Initialiser structures |
| caseless | New keys are to be PCaselessStrings |
|
virtual |
Input the contents of the object from the stream.
This is primarily used by the standard operator>> function.
The default behaviour reads '\n' separated strings until !strm.good().
1.8.5 
