virtual PINDEX Append( PObject* obj )
- Add a new object to the collection. If the objects value is already in
the set then the object is not included. If the
AllowDeleteObjects option is set then the obj parameter
is also deleted.
- Parameters:
- obj - New object to place into the collection.
- Returns:
- hash function value of the newly added object.
virtual PINDEX Insert( const PObject & before, PObject* obj )
- Add a new object to the collection. If the objects value is already in
the set then the object is not included. If the
AllowDeleteObjects option is set then the obj parameter is
also deleted.
The object is always placed in the an ordinal position dependent on its
hash function. It is not placed at the specified position. The
before parameter is ignored.
- Parameters:
- before - Object value to insert before.
obj - New object to place into the collection.
- Returns:
- hash function value of the newly added object.
virtual PINDEX InsertAt( PINDEX index, PObject* obj )
- Add a new object to the collection. If the objects value is already in
the set then the object is not included. If the
AllowDeleteObjects option is set then the obj parameter is
also deleted.
The object is always placed in the an ordinal position dependent on its
hash function. It is not placed at the specified position. The
index parameter is ignored.
- Parameters:
- index - Index position in collection to place the object.
obj - New object to place into the collection.
- Returns:
- hash function value of the newly added object.
virtual BOOL Remove( const PObject* obj )
- Remove the object from the collection. If the AllowDeleteObjects option
is set then the object is also deleted.
Note that the comparison for searching for the object in collection is
made by pointer, not by value. Thus the parameter must point to the
same instance of the object that is in the collection.
- Parameters:
- obj - Existing object to remove from the collection.
- Returns:
- TRUE if the object was in the collection.
virtual PObject* RemoveAt( PINDEX index )
- Remove an object at the specified index. 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 PObject* GetAt( PINDEX index ) const
- This function is the same as PHashTable::AbstractGetKeyAt().
- Parameters:
- index - Index position in the collection of the object.
- Returns:
- Always NULL.
virtual BOOL SetAt( PINDEX index, PObject* val )
- Add a new object to the collection. If the objects value is already in
the set then the object is not included. If the
AllowDeleteObjects option is set then the obj parameter is
also deleted.
The object is always placed in the an ordinal position dependent on its
hash function. It is not placed at the specified position. The
index parameter is ignored.
- 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 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 equal value.
- Returns:
- ordinal index position of the object, or P_MAX_INDEX.