An abstract dictionary container
Inheritance:
Public Methods
| Construction
|
| Overrides from class PObject
|
| Overrides from class PCollection
|
| New functions for class
|
Protected Methods
-
Overrides from class PContainer
Public Methods
-
Common functions for collections
Public Methods
-
Common functions for containers
Protected Methods
-
virtual void DestroyContents()
-
virtual void AssignContents(const PContainer & c)
-
void CopyContents(const PContainer & c)
-
void CloneContents(const PContainer* src)
-
void Destruct()
Inherited from PObject:
Public Methods
-
Run Time Type functions
-
I/O functions
Public Members
-
Comparison functions
Documentation
An abstract dictionary container
Construction
PINLINE 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.
Overrides from class PObject
virtual void PrintOn( ostream &strm ) const
- 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.
- Parameters:
- - strm Stream to print the object into.
Overrides from class PCollection
virtual PINDEX Insert( const PObject & key, PObject* obj )
- 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.
- Parameters:
- - key Object value to use as the key.
obj - New object to place into the collection.
- Returns:
- Always zero.
virtual PINDEX InsertAt( PINDEX index, PObject* obj )
- Insert a new object at the specified index. The index is as is used in
the GetKeyAt() function.
- Parameters:
- index - Index position in collection to place the object.
obj - New object to place into the collection.
- Returns:
- index parameter.
virtual PObject* RemoveAt( PINDEX index )
- 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.
- Parameters:
- index - Index position in collection to place the object.
- Returns:
- pointer to the object being removed, or NULL if it was deleted.
virtual BOOL SetAt( PINDEX index, PObject* val )
- 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.
- Parameters:
- index - Index position in collection to set.
val - New value to place into the collection.
- Returns:
- TRUE if the object was successfully added.
virtual PObject* GetAt( PINDEX index ) const
- 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.
- Parameters:
- index - Index position in the collection of the object.
- Returns:
- pointer to object at the specified index.
virtual PINDEX GetObjectsIndex( const PObject* obj ) const
- 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.
- Parameters:
- obj - Object to find.
- Returns:
- ordinal index position of the object, or P_MAX_INDEX.
virtual PINDEX GetValuesIndex( const PObject & obj ) const
- 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.
- Parameters:
- obj - Object to find value of.
- Returns:
- ordinal index position of the object, or P_MAX_INDEX.
New functions for class
virtual BOOL SetDataAt( PINDEX index, PObject* obj )
- 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.
- Parameters:
- index - Ordinal index in the dictionary.
obj - New object to put into the dictionary.
- Returns:
- TRUE if the new object could be placed into the dictionary.
virtual BOOL AbstractSetAt( const PObject & key, PObject* obj )
- 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.
- Parameters:
- - key Key for position in dictionary to add object.
obj - New object to put into the dictionary.
- Returns:
- TRUE if the object was successfully added.
virtual PObject& GetRefAt( const PObject & key ) const
- 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.
- Parameters:
- - key Key for position in dictionary to get object.
- Returns:
- reference to object at the specified key.
virtual PObject* AbstractGetAt( const PObject & key ) const
- Get the object at the specified key position. If the key was not in the
collection then NULL is returned.
- Parameters:
- - key Key for position in dictionary to get object.
- Returns:
- pointer to object at the specified key.
- Direct child classes:
- PStringDictionary
POrdinalDictionary
PDictionary
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.