PTLib  Version 2.10.10
PvCard::TextValues Class Reference

Comma separated list of text-value's. More...

#include <vcard.h>

Inheritance diagram for PvCard::TextValues:
PArray< TextValue > PArrayObjects PCollection PContainer PObject

Public Member Functions

virtual void PrintOn (ostream &strm) const
 Print the collection on the stream. More...
 
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream. More...
 
- Public Member Functions inherited from PArray< TextValue >
 PArray (PINDEX initialSize=0)
 Create a new array of objects. More...
 
virtual PObjectClone () const
 Make a complete duplicate of the array. More...
 
TextValue & operator[] (PINDEX index) const
 Retrieve a reference to the object in the array. More...
 
- Public Member Functions inherited from PArrayObjects
PINLINE PArrayObjects (PINDEX initialSize=0)
 Create a new array of objects. More...
 
virtual Comparison Compare (const PObject &obj) const
 Get the relative rank of the two arrays. More...
 
virtual PINDEX GetSize () const
 Get size of array. More...
 
virtual PBoolean SetSize (PINDEX newSize)
 Set the size of the array in objects. More...
 
virtual PINDEX Append (PObject *obj)
 Append a new object to the collection. More...
 
virtual PINDEX Insert (const PObject &before, PObject *obj)
 Insert a new object immediately before the specified object. More...
 
virtual PINDEX InsertAt (PINDEX index, PObject *obj)
 Insert a new object at the specified ordinal index. More...
 
virtual PBoolean Remove (const PObject *obj)
 Remove the object from the collection. More...
 
virtual PObjectRemoveAt (PINDEX index)
 Remove the object at the specified ordinal index from the collection. More...
 
virtual PBoolean SetAt (PINDEX index, PObject *val)
 Set the object at the specified ordinal position to the new value. More...
 
virtual PObjectGetAt (PINDEX index) const
 Get the object at the specified ordinal position. More...
 
virtual PINDEX GetObjectsIndex (const PObject *obj) const
 Search the collection for the specific instance of the object. More...
 
virtual PINDEX GetValuesIndex (const PObject &obj) const
 Search the collection for the specified value of the object. More...
 
virtual void RemoveAll ()
 Remove all of the elements in the collection. More...
 
- Public Member Functions inherited from PCollection
 PCollection (PINDEX initialSize=0)
 Create a new collection. More...
 
PINLINE void AllowDeleteObjects (PBoolean yes=true)
 Allow or disallow the deletion of the objects contained in the collection. More...
 
void DisallowDeleteObjects ()
 Disallow the deletion of the objects contained in the collection. 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...
 
PContaineroperator= (const PContainer &cont)
 Assign one container reference to another. More...
 
virtual ~PContainer ()
 Destroy the container class. More...
 
PBoolean SetMinSize (PINDEX minSize)
 Set the minimum size of container. More...
 
virtual PBoolean IsEmpty () const
 Determine if the container is empty. More...
 
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
virtual ~PObject ()
 
virtual PINDEX HashFunction () const
 This function yields a hash value required by the PDictionary class. More...
 
virtual const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance. More...
 
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. 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 const char * Class ()
 Get the name of the class as a C string. More...
 
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect() More...
 
- Protected Member Functions inherited from PArray< TextValue >
 PArray (int dummy, const PArray *c)
 
- Protected Member Functions inherited from PCollection
PINLINE PCollection (int dummy, const PCollection *coll)
 Constructor used in support of the Clone() function. More...
 
- 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 PArrayObjects
PBaseArray< PObject * > * theArray
 
- Protected Attributes inherited from PContainer
PContainerReferencereference
 

Detailed Description

Comma separated list of text-value's.

Member Function Documentation

virtual void PvCard::TextValues::PrintOn ( ostream &  strm) const
virtual

Print the collection on the stream.

This simply executes the PObject::PrintOn() function on each element in the collection.

The default behaviour for collections is to print each element separated by the stream fill character. Note that if the fill character is the default ' ' then no separator is printed at all.

Also if the fill character is not ' ', the the streams width parameter is set before each individual element of the colllection.

Returns
the stream printed to.

Reimplemented from PCollection.

virtual void PvCard::TextValues::ReadFrom ( istream &  strm)
virtual

Input the contents of the object from the stream.

The exact input is dependent on the exact semantics of the descendent class. This is primarily used by the standard operator>> function.

The default behaviour is to do nothing.

Reimplemented from PObject.


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