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

This is a sorted list collection class of PString objects. More...

#include <pstring.h>

Inheritance diagram for PSortedStringList:
PSortedList< T > PAbstractSortedList PCollection PContainer PObject

Public Member Functions

Construction
 PSortedStringList (PINDEX count, char const *const *strarr, PBoolean caseless=false)
 Create a PStringArray from the array of C strings.
 PSortedStringList (const PString &str)
 Create a PSortedStringList of length one from the single string.
 PSortedStringList (const PStringArray &array)
 Create a PSortedStringList from the array of strings.
 PSortedStringList (const PStringList &list)
 Create a PSortedStringList from the list of strings.
Overrides from class PObject
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream.
Operations
PINDEX AppendString (const PString &str)
 Add a string to the list.
PINDEX GetStringsIndex (const PString &str) const
 Get the index of the string with the specified value.
PINDEX GetNextStringsIndex (const PString &str) const
 Get the index of the next string after specified value.
- Public Member Functions inherited from PSortedList< T >
 PSortedList ()
 Create a new, empty, sorted list.
virtual PObjectClone () const
 Make a complete duplicate of the list.
T & operator[] (PINDEX index) const
 Retrieve a reference to the object in the list.
- Public Member Functions inherited from PAbstractSortedList
 PAbstractSortedList ()
 Create a new, empty, sorted list.
virtual Comparison Compare (const PObject &obj) const
 Get the relative rank of the two lists.
virtual PBoolean SetSize (PINDEX newSize)
 This function is meaningless for lists.
virtual PINDEX Append (PObject *obj)
 Add a new object to the collection.
virtual PINDEX Insert (const PObject &before, PObject *obj)
 Add a new object to the collection.
virtual PINDEX InsertAt (PINDEX index, PObject *obj)
 Add a new object to the collection.
virtual PBoolean Remove (const PObject *obj)
 Remove the object from the collection.
virtual PObjectRemoveAt (PINDEX index)
 Remove the object at the specified ordinal index from the collection.
virtual void RemoveAll ()
 Remove all of the elements in the collection.
virtual PBoolean SetAt (PINDEX index, PObject *val)
 This method simply returns false as the list order is mantained by the class.
virtual PObjectGetAt (PINDEX index) const
 Get the object at the specified ordinal position.
virtual PINDEX GetObjectsIndex (const PObject *obj) const
 Search the collection for the specific instance of the object.
virtual PINDEX GetObjectsIndex (const PObject *obj, PSortedListElement *&lastElement) const
virtual PINDEX GetValuesIndex (const PObject &obj) const
 Search the collection for the specified value of the object.
- Public Member Functions inherited from PCollection
 PCollection (PINDEX initialSize=0)
 Create a new collection.
virtual void PrintOn (ostream &strm) const
 Print the collection on the stream.
PINLINE void AllowDeleteObjects (PBoolean yes=true)
 Allow or disallow the deletion of the objects contained in the collection.
void DisallowDeleteObjects ()
 Disallow the deletion of the objects contained in the collection.
- 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 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.
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.

Protected Member Functions

PINDEX InternalStringSelect (const char *str, PINDEX len, Element *thisElement, Element *&lastElement) const
- Protected Member Functions inherited from PSortedList< T >
 PSortedList (int dummy, const PSortedList *c)
- Protected Member Functions inherited from PAbstractSortedList
void RemoveElement (Element *node)
void LeftRotate (Element *node)
void RightRotate (Element *node)
void DeleteSubTrees (Element *node, PBoolean deleteObject)
PINDEX ValueSelect (const Element *node, const PObject &obj, const Element **lastElement) const
- Protected Member Functions inherited from PCollection
PINLINE PCollection (int dummy, const PCollection *coll)
 Constructor used in support of the Clone() function.
- Protected Member Functions inherited from PContainer
 PContainer (int dummy, const PContainer *cont)
 Constructor used in support of the Clone() function.
 PContainer (PContainerReference &reference)
 Construct using static PContainerReference.
virtual void DestroyContents ()=0
 Destroy the container contents.
virtual void AssignContents (const PContainer &c)
 Copy the container contents.
void CopyContents (const PContainer &c)
 Copy the container contents.
void CloneContents (const PContainer *src)
 Create a duplicate of the container contents.
void Destruct ()
 Internal function called from container destructors.
virtual void DestroyReference ()
 Destroy the PContainerReference instance.
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own.

Additional Inherited Members

- Public Types inherited from PAbstractSortedList
typedef PSortedListElement Element
- Static Public Member Functions inherited from PObject
static const char * Class ()
 Get the name of the class as a C string.
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect()
- Protected Attributes inherited from PAbstractSortedList
PSortedListInfoinfo
- Friends inherited from PObject

Detailed Description

This is a sorted list collection class of PString objects.

It has all the usual functions for a collection, with the object types set to PString pointers.

In addition some addition functions are added that take a const PString reference instead of a pointer as most standard collection functions do. This is more convenient for when string expressions are used as parameters to function in the collection.

See the PAbstractSortedList and PSortedList classes for more information.

Constructor & Destructor Documentation

PSortedStringList::PSortedStringList ( PINDEX  count,
char const *const *  strarr,
PBoolean  caseless = false 
)

Create a PStringArray from the array of C strings.

Parameters
countCount of strings in array
strarrArray of C strings
caselessNew strings are to be PCaselessStrings
PSortedStringList::PSortedStringList ( const PString str)

Create a PSortedStringList of length one from the single string.

Parameters
strSingle string to convert to a list of one.
PSortedStringList::PSortedStringList ( const PStringArray array)

Create a PSortedStringList from the array of strings.

Parameters
arrayArray of strings to convert to list
PSortedStringList::PSortedStringList ( const PStringList list)

Create a PSortedStringList from the list of strings.

Parameters
listList of strings to convert to list.

Member Function Documentation

PINDEX PSortedStringList::AppendString ( const PString str)

Add a string to the list.

This will place the string in the correct position in the sorted list.

Parameters
strString to append.
PINDEX PSortedStringList::GetNextStringsIndex ( const PString str) const

Get the index of the next string after specified value.

A binary search of tree is performed to find the string greater than or equal to the specified string value.

Parameters
strString value to search for.
PINDEX PSortedStringList::GetStringsIndex ( const PString str) const

Get the index of the string with the specified value.

A binary search of tree is performed to find the string value.

Parameters
strString value to search for.
PINDEX PSortedStringList::InternalStringSelect ( const char *  str,
PINDEX  len,
Element thisElement,
Element *&  lastElement 
) const
protected
virtual void PSortedStringList::ReadFrom ( istream &  strm)
virtual

Input the contents of the object from the stream.

This is primarily used by the standard operator>> function.

The default behaviour reads '\n' separated strings until !strm.good().

Reimplemented from PObject.


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