PStringToOrdinal Class Reference

#include <pstring.h>

Inheritance diagram for PStringToOrdinal:
POrdinalDictionary< K > PAbstractDictionary PHashTable PCollection PContainer PObject

List of all members.

Classes

struct  Initialiser
 Structure for static array initialiser for class. More...

Public Member Functions

Construction

 PStringToOrdinal (PINDEX count, const Initialiser *init, PBoolean caseless=PFalse)
Overrides from class PObject

virtual void ReadFrom (istream &strm)

Detailed Description

This is a dictionary collection class of ordinals keyed by PString# objects. It has all the usual functions for a collection, with the object types set to POrdinalKey# pointers.

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

See the PAbstractDicionary# and POrdinalDictionary# classes and PDECLARE_ORDINAL_DICTIONARY# macro for more information.


Constructor & Destructor Documentation

PStringToOrdinal::PStringToOrdinal ( PINDEX  count,
const Initialiser init,
PBoolean  caseless = PFalse 
)

Initialise the string dictionary of ordinals from the static array.

Parameters:
count Count of strings in initialiser array
init Array of Initialiser structures
caseless New keys are to be PCaselessStrings

Member Function Documentation

virtual void PStringToOrdinal::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 '
' separated strings until !strm.good().

Reimplemented from PObject.


The documentation for this class was generated from the following file:
Generated on Fri May 28 07:32:36 2010 for PTLib by  doxygen 1.6.3