PTLib  Version 2.10.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PCharArray Class Reference

Array of characters. More...

#include <array.h>

Inheritance diagram for PCharArray:
PBaseArray< T > PAbstractArray PContainer PObject PString PCaselessString PFilePathString PHTTPSpace::Node PSOAPServerMethod PStringStream PvCard::ParamValue PvCard::TextValue PXMLRPCServerMethod

Public Member Functions

Construction
 PCharArray (PINDEX initialSize=0)
 Construct a new dynamic array of char.
 PCharArray (char const *buffer, PINDEX length, PBoolean dynamic=true)
 Construct a new dynamic array of char.
Overrides from class PObject
virtual void PrintOn (ostream &strm) const
 Print the array.
virtual void ReadFrom (istream &strm)
 Read the array.
- Public Member Functions inherited from PBaseArray< T >
 PBaseArray (PINDEX initialSize=0)
 Construct a new dynamic array of elements of the specified type.
 PBaseArray (T const *buffer, PINDEX length, PBoolean dynamic=true)
 Construct a new dynamic array of elements of the specified type.
virtual PObjectClone () const
 Clone the object.
PBoolean SetAt (PINDEX index, T val)
 Set the specific element in the array.
GetAt (PINDEX index) const
 Get a value from the array.
void Attach (const T *buffer, PINDEX bufferSize)
 Attach a pointer to a static block to the base array type.
T * GetPointer (PINDEX minSize=0)
 Get a pointer to the internal array and assure that it is of at least the specified size.
operator[] (PINDEX index) const
 Get a value from the array.
T & operator[] (PINDEX index)
 Get a reference to value from the array.
 operator T const * () const
 Get a pointer to the internal array.
PBoolean Concatenate (const PBaseArray &array)
 Concatenate one array to the end of this array.
- Public Member Functions inherited from PAbstractArray
 PAbstractArray (PINDEX elementSizeInBytes, PINDEX initialSize=0)
 Create a new dynamic array of initalSize elements of elementSizeInBytes bytes each.
 PAbstractArray (PINDEX elementSizeInBytes, const void *buffer, PINDEX bufferSizeInElements, PBoolean dynamicAllocation)
 Create a new dynamic array of bufferSizeInElements elements of elementSizeInBytes bytes each.
virtual Comparison Compare (const PObject &obj) const
 Get the relative rank of the two arrays.
virtual PBoolean SetSize (PINDEX newSize)
 Set the size of the array in elements.
void Attach (const void *buffer, PINDEX bufferSize)
 Attach a pointer to a static block to the base array type.
PBoolean Concatenate (const PAbstractArray &array)
 Concatenate one array to the end of this array.
- Public Member Functions inherited from PContainer
 PContainer (PINDEX initialSize=0)
 Create a new unique container.
 PContainer (const PContainer &cont)
 Create a new refernce to container.
PContaineroperator= (const PContainer &cont)
 Assign one container reference to another.
virtual ~PContainer ()
 Destroy the container class.
virtual PINDEX GetSize () const
 Get the current size of the container.
PBoolean SetMinSize (PINDEX minSize)
 Set the minimum size of container.
virtual PBoolean IsEmpty () const
 Determine if the container is empty.
PBoolean IsUnique () const
 Determine if container is unique reference.
virtual PBoolean MakeUnique ()
 Make this instance to be the one and only reference to the container contents.
- Public Member Functions inherited from PObject
virtual ~PObject ()
virtual PINDEX HashFunction () const
 This function yields a hash value required by the PDictionary class.
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects.
bool operator== (const PObject &obj) const
 Compare the two objects.
bool operator!= (const PObject &obj) const
 Compare the two objects.
bool operator< (const PObject &obj) const
 Compare the two objects.
bool operator> (const PObject &obj) const
 Compare the two objects.
bool operator<= (const PObject &obj) const
 Compare the two objects.
bool operator>= (const PObject &obj) const
 Compare the two objects.
virtual const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance.
PBoolean IsClass (const char *cls) const
virtual PBoolean InternalIsDescendant (const char *clsName) const
 Determine if the dynamic type of the current instance is a descendent of the specified class.

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 Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect()
static const char * Class ()
 Get the name of the class as a C string.
- Protected Member Functions inherited from PBaseArray< T >
virtual void PrintElementOn (ostream &stream, PINDEX index) const
 PBaseArray (PContainerReference &reference)
- Protected Attributes inherited from PAbstractArray
PINDEX elementSize
 Size of an element in bytes.
char * theArray
 Pointer to the allocated block of memory.
PBoolean allocatedDynamically
 Flag indicating the array was allocated on the heap.
- Friends inherited from PObject

Detailed Description

Array of characters.

Constructor & Destructor Documentation

PCharArray::PCharArray ( PINDEX  initialSize = 0)

Construct a new dynamic array of char.

The array is initialised to all zero bytes.

Parameters
initialSizeInitial number of elements in the array.
PCharArray::PCharArray ( char const *  buffer,
PINDEX  length,
PBoolean  dynamic = true 
)

Construct a new dynamic array of char.

Parameters
bufferPointer to an array of chars.
lengthNumber of elements pointed to by buffer.
dynamicBuffer is copied and dynamically allocated.

Member Function Documentation

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

Print the array.

Parameters
strmStream to output to.

Reimplemented from PAbstractArray.

Reimplemented in PString, PvCard::TextValue, PvCard::ParamValue, and PvCard::Token.

virtual void PCharArray::ReadFrom ( istream &  strm)
virtual

Read the array.

Reimplemented from PAbstractArray.

Reimplemented in PString, PvCard::TextValue, PvCard::ParamValue, and PvCard::Token.


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