Array of unsigned characters. More...

#include <array.h>

Inheritance diagram for PBYTEArray:

Collaboration diagram for PBYTEArray:

Public Member Functions
template<typename T >
const T &	GetAs (PINDEX offset=0)
	Function to cast block of memory in PBYTEArray to another structure. More...

Construction
	PBYTEArray (PINDEX initialSize=0)
	Construct a new dynamic array of unsigned chars. More...

	PBYTEArray (BYTE const *buffer, PINDEX length, PBoolean dynamic=true)
	Construct a new dynamic array of unsigned chars. More...

	PBYTEArray (PContainerReference &reference_)

Overrides from class PObject
virtual void	PrintOn (ostream &strm) const
	Print the array. More...

virtual void	ReadFrom (istream &strm)
	Read the array. More...

virtual PObject *	Clone () const
	Clone the object. More...

Public Member Functions inherited from PBaseArray< BYTE >
	PBaseArray (PINDEX initialSize=0)
	Construct a new dynamic array of elements of the specified type. More...

	PBaseArray (BYTEconst *buffer, PINDEX length, PBoolean dynamic=true)
	Construct a new dynamic array of elements of the specified type. More...

PBoolean	SetAt (PINDEX index, BYTEval)
	Set the specific element in the array. More...

BYTE	GetAt (PINDEX index) const
	Get a value from the array. More...

void	Attach (const BYTE *buffer, PINDEX bufferSize)
	Attach a pointer to a static block to the base array type. More...

BYTE *	GetPointer (PINDEX minSize=0)
	Get a pointer to the internal array and assure that it is of at least the specified size. More...

BYTE	operator[] (PINDEX index) const
	Get a value from the array. More...

BYTE &	operator[] (PINDEX index)
	Get a reference to value from the array. More...

	operator BYTEconst * () 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 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...

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< BYTE >
	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	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 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

Detailed Description

Array of unsigned characters.

Constructor & Destructor Documentation

PBYTEArray::PBYTEArray ( PINDEX initialSize = 0 )

inline

Construct a new dynamic array of unsigned chars.

The array is initialised to all zeros.

Parameters

initialSize Initial number of elements in the array.

Referenced by Clone().

PBYTEArray::PBYTEArray	(	BYTE const *	buffer,
		PINDEX	length,
		PBoolean	dynamic = `true`
	)

inline

Construct a new dynamic array of unsigned chars.

Parameters

buffer	Pointer to an array of BYTEs.
length	Number of elements pointed to by `buffer`.
dynamic	Buffer is copied and dynamically allocated.

PBYTEArray::PBYTEArray ( PContainerReference & reference_ )

inline

Member Function Documentation

virtual PObject* PBYTEArray::Clone ( ) const

inlinevirtual

Clone the object.

Reimplemented from PBaseArray< BYTE >.

Reimplemented in PBitArray.

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

template<typename T >

const T& PBYTEArray::GetAs ( PINDEX offset = 0 )

inline

Function to cast block of memory in PBYTEArray to another structure.

References PContainer::GetSize(), PAssert, PInvalidParameter, and PAbstractArray::theArray.

virtual void PBYTEArray::PrintOn ( ostream & strm ) const

virtual

Print the array.

Parameters

strm	Stream to output to.

Reimplemented from PAbstractArray.

Reimplemented in PHexDump.

virtual void PBYTEArray::ReadFrom ( istream & strm )

virtual

Read the array.

Parameters

strm	Stream to read the objects contents from.

Reimplemented from PAbstractArray.

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

array.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation