#include <dict.h>
Inheritance diagram for PAbstractDictionary:
Public Member Functions | |
Overrides from class PObject | |
| virtual void | PrintOn (ostream &strm) const |
Overrides from class PCollection | |
| virtual PINDEX | Insert (const PObject &key, PObject *obj) |
| virtual PINDEX | InsertAt (PINDEX index, PObject *obj) |
| virtual PObject * | RemoveAt (PINDEX index) |
| virtual BOOL | SetAt (PINDEX index, PObject *val) |
| virtual PObject * | GetAt (PINDEX index) const |
| virtual PINDEX | GetObjectsIndex (const PObject *obj) const |
| virtual PINDEX | GetValuesIndex (const PObject &obj) const |
New functions for class | |
| virtual BOOL | SetDataAt (PINDEX index, PObject *obj) |
| virtual BOOL | AbstractSetAt (const PObject &key, PObject *obj) |
| virtual PObject & | GetRefAt (const PObject &key) const |
| virtual PObject * | AbstractGetAt (const PObject &key) const |
Protected Member Functions | |
| PINLINE | PAbstractDictionary (int dummy, const PAbstractDictionary *c) |
| PINLINE PAbstractDictionary::PAbstractDictionary | ( | ) |
Create a new, empty, dictionary.
Note that by default, objects placed into the dictionary will be deleted when removed or when all references to the dictionary are destroyed.
| PINLINE PAbstractDictionary::PAbstractDictionary | ( | int | dummy, | |
| const PAbstractDictionary * | c | |||
| ) | [protected] |
| PINLINE PAbstractDictionary::PAbstractDictionary | ( | ) |
Create a new, empty, dictionary.
Note that by default, objects placed into the dictionary will be deleted when removed or when all references to the dictionary are destroyed.
| virtual void PAbstractDictionary::PrintOn | ( | ostream & | strm | ) | const [virtual] |
Output the contents of the object to the stream. The exact output is dependent on the exact semantics of the descendent class. This is primarily used by the standard #operator<<## function.
The default behaviour is to print the class name.
| strm | Stream to print the object into. |
Reimplemented from PCollection.
Insert a new object into the dictionary. The semantics of this function is different from that of the PCollection# class. This function is exactly equivalent to the SetAt() function that sets a data value at the key value location.
| key | Object value to use as the key. |
| obj | New object to place into the collection. |
Implements PCollection.
| virtual PINDEX PAbstractDictionary::InsertAt | ( | PINDEX | index, | |
| PObject * | obj | |||
| ) | [virtual] |
Insert a new object at the specified index. The index is as is used in the GetKeyAt()# function.
| index | Index position in collection to place the object. |
| obj | New object to place into the collection. |
Implements PCollection.
| virtual PObject* PAbstractDictionary::RemoveAt | ( | PINDEX | index | ) | [virtual] |
Remove an object at the specified index. The index is as is used in the GetKeyAt()# function. The returned pointer is then removed using the SetAt()# function to set that key value to NULL. If the AllowDeleteObjects# option is set then the object is also deleted.
| index | Index position in collection to place the object. |
Implements PCollection.
| virtual BOOL PAbstractDictionary::SetAt | ( | PINDEX | index, | |
| PObject * | val | |||
| ) | [virtual] |
Set the object at the specified index to the new value. The index is as is used in the GetKeyAt()# function. This will overwrite the existing entry. If the AllowDeleteObjects option is set then the old object is also deleted.
| index | Index position in collection to set. |
| val | New value to place into the collection. |
Implements PCollection.
| virtual PObject* PAbstractDictionary::GetAt | ( | PINDEX | index | ) | const [virtual] |
Get the object at the specified index position. The index is as is used in the GetKeyAt()# function. If the index was not in the collection then NULL is returned.
| index | Index position in the collection of the object. |
Implements PCollection.
| virtual PINDEX PAbstractDictionary::GetObjectsIndex | ( | const PObject * | obj | ) | const [virtual] |
Search the collection for the specific instance of the object. The object pointers are compared, not the values. The hash table is used to locate the entry.
Note that that will require value comparisons to be made to find the equivalent entry and then a final check is made with the pointers to see if they are the same instance.
| obj | Object to find. |
Implements PCollection.
| virtual PINDEX PAbstractDictionary::GetValuesIndex | ( | const PObject & | obj | ) | const [virtual] |
Search the collection for the specified value of the object. The object values are compared, not the pointers. So the objects in the collection must correctly implement the PObject::Compare()# function. The hash table is used to locate the entry.
| obj | Object to find value of. |
Implements PCollection.
| virtual BOOL PAbstractDictionary::SetDataAt | ( | PINDEX | index, | |
| PObject * | obj | |||
| ) | [virtual] |
Set the data at the specified ordinal index position in the dictionary.
The ordinal position in the dictionary is determined by the hash values of the keys and the order of insertion.
| index | Ordinal index in the dictionary. |
| obj | New object to put into the dictionary. |
Add a new object to the collection. If the objects value is already in the dictionary then the object is overrides the previous value. If the AllowDeleteObjects option is set then the old object is also deleted.
The object is placed in the an ordinal position dependent on the keys hash function. Subsequent searches use the has function to speed access to the data item.
| key | Key for position in dictionary to add object. |
| obj | New object to put into the dictionary. |
Get the object at the specified key position. If the key was not in the collection then this function asserts.
This function is primarily for use by the operator[]# function is descendent template classes.
| key | Key for position in dictionary to get object. |
Get the object at the specified key position. If the key was not in the collection then NULL is returned.
| key | Key for position in dictionary to get object. |
1.5.1