PHashTableInfo Class Reference

#include <dict.h>

Inheritance diagram for PHashTableInfo:

Collaboration diagram for PHashTableInfo:

Public Member Functions
	PHashTableInfo (PINDEX initialSize=0)
	PHashTableInfo (PHashTableList const *buffer, PINDEX length, PBoolean dynamic=true)
virtual PObject *	Clone () const
	Clone the object. More...
virtual	~PHashTableInfo ()
virtual void	DestroyContents ()
	Destroy the container contents. More...
void	AppendElement (PObject *key, PObject *data PTRACE_PARAM(, PHashTable *owner))
PObject *	RemoveElement (const PObject &key)
PHashTableElement *	GetElementAt (PINDEX index)
PHashTableElement *	GetElementAt (const PObject &key)
PINDEX	GetElementsIndex (const PObject *obj, PBoolean byVal, PBoolean keys) const
PHashTableElement *	NextElement (PHashTableElement *element) const
PHashTableElement *	PrevElement (PHashTableElement *element) const
	PTRACE_THROTTLE (m_throttlePoorHashFunction, 1)
Public Member Functions inherited from PBaseArray< PHashTableList >
	PBaseArray (PINDEX initialSize=0)
	Construct a new dynamic array of elements of the specified type. More...
	PBaseArray (PHashTableListconst *buffer, PINDEX length, PBoolean dynamic=true)
	Construct a new dynamic array of elements of the specified type. More...
PBoolean	SetAt (PINDEX index, PHashTableListval)
	Set the specific element in the array. More...
PHashTableList	GetAt (PINDEX index) const
	Get a value from the array. More...
void	Attach (const PHashTableList *buffer, PINDEX bufferSize)
	Attach a pointer to a static block to the base array type. More...
PHashTableList *	GetPointer (PINDEX minSize=0)
	Get a pointer to the internal array and assure that it is of at least the specified size. More...
PHashTableList	operator[] (PINDEX index) const
	Get a value from the array. More...
PHashTableList &	operator[] (PINDEX index)
	Get a reference to value from the array. More...
	operator PHashTableListconst * () const
	Get a pointer to the internal array. More...
PBoolean	Concatenate (const PBaseArray &array)
	Concatenate one array to the end of this array. More...
Public Member Functions inherited from PAbstractArray
	PAbstractArray (PINDEX elementSizeInBytes, PINDEX initialSize=0)
	Create a new dynamic array of initalSize elements of elementSizeInBytes bytes each. More...
	PAbstractArray (PINDEX elementSizeInBytes, const void *buffer, PINDEX bufferSizeInElements, PBoolean dynamicAllocation)
	Create a new dynamic array of bufferSizeInElements elements of elementSizeInBytes bytes each. More...
virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...
virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...
virtual Comparison	Compare (const PObject &obj) const
	Get the relative rank of the two arrays. More...
virtual PBoolean	SetSize (PINDEX newSize)
	Set the size of the array in elements. More...
void	Attach (const void *buffer, PINDEX bufferSize)
	Attach a pointer to a static block to the base array type. More...
void *	GetPointer (PINDEX minSize=1)
	Get a pointer to the internal array and assure that it is of at least the specified size. More...
const void *	GetPointer () const
virtual PINDEX	GetLength () const
	Retrun the length in bytes for the array. More...
PBoolean	Concatenate (const PAbstractArray &array)
	Concatenate one array to the end of this array. 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...

Public Attributes
bool	deleteKeys

Additional Inherited Members
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...
Protected Member Functions inherited from PBaseArray< PHashTableList >
	PBaseArray (PContainerReference &reference_)
virtual void	PrintElementOn (ostream &stream, PINDEX index) const
Protected Member Functions inherited from PAbstractArray
PBoolean	InternalSetSize (PINDEX newSize, PBoolean force)
virtual void	PrintElementOn (ostream &stream, PINDEX index) const
virtual void	ReadElementFrom (istream &stream, PINDEX index)
	PAbstractArray (PContainerReference &reference, PINDEX elementSizeInBytes)
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	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 PAbstractArray
PINDEX	elementSize
	Size of an element in bytes. More...
char *	theArray
	Pointer to the allocated block of memory. More...
PBoolean	allocatedDynamically
	Flag indicating the array was allocated on the heap. More...
Protected Attributes inherited from PContainer
PContainerReference *	reference
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Constructor & Destructor Documentation

PHashTableInfo::PHashTableInfo ( PINDEX  initialSize = 0 )

inline

Referenced by Clone().

PHashTableInfo::PHashTableInfo ( PHashTableList const *  buffer, PINDEX  length, PBoolean  dynamic = true  )

inline

virtual PHashTableInfo::~PHashTableInfo ( )

inlinevirtual

References PContainer::Destruct().

Member Function Documentation

void PHashTableInfo::AppendElement	(	PObject *	key,
		PObject *data	PTRACE_PARAM, PHashTable *owner
	)

virtual PObject* PHashTableInfo::Clone ( ) const

inlinevirtual

Clone the object.

Reimplemented from PBaseArray< PHashTableList >.

References PContainer::GetSize(), PHashTableInfo(), and PNEW.

virtual void PHashTableInfo::DestroyContents ( )

virtual

Destroy the container contents.

This function must be defined by the descendent class to do the actual destruction of the contents. It is automatically declared when the PCONTAINERINFO() macro is used.

For all descendent classes not immediately inheriting off the PContainer itself, the implementation of DestroyContents() should always call its ancestors function. This is especially relevent if many of the standard container classes, such as arrays, are descended from as memory leaks will occur.

Implements PContainer.

PHashTableElement* PHashTableInfo::GetElementAt

(

PINDEX

index

)

Referenced by PDictionary< K, D >::iterator_base::iterator_base().

PHashTableElement* PHashTableInfo::GetElementAt

(

const PObject &

key

)

PINDEX PHashTableInfo::GetElementsIndex	(	const PObject *	obj,
		PBoolean	byVal,
		PBoolean	keys
	)		const

PHashTableElement* PHashTableInfo::NextElement

(

PHashTableElement *

element

)

const

PHashTableElement* PHashTableInfo::PrevElement

(

PHashTableElement *

element

)

const

PHashTableInfo::PTRACE_THROTTLE	(	m_throttlePoorHashFunction	,
		1
	)

PObject* PHashTableInfo::RemoveElement

(

const PObject &

key

)

Member Data Documentation

bool PHashTableInfo::deleteKeys

---

The documentation for this class was generated from the following file:

• dict.h