class POrdinalKey

This class is used when an ordinal index value is the key for PSet and PDictionary classes

Inheritance:


Public Methods

[more] Construction
[more] Overrides from class PObject
[more] New functions for class


Inherited from PObject:

Public Methods

Run Time Type functions

I/O functions

Public Members

Comparison functions


Documentation

This class is used when an ordinal index value is the key for PSet and PDictionary classes
o Construction

oPINLINE POrdinalKey( PINDEX newKey = 0 )
Create a new key for ordinal index values.
Parameters:
newKey - Ordinal index value to use as a key.

oPINLINE POrdinalKey& operator=(PINDEX)
Operator to assign the ordinal

o Overrides from class PObject

ovirtual PObject* Clone() const
Create a duplicate of the POrdinalKey

ovirtual PINDEX HashFunction() const
This function calculates a hash table index value for the implementation of PSet and PDictionary classes.

Returns:
hash table bucket number.

ovirtual void PrintOn(ostream & strm) const
Output the ordinal index to the specified stream. This is identical to outputting the PINDEX, ie integer, value.

Returns:
stream that the index was output to.

o New functions for class

oPINLINE operator PINDEX() const
Operator so that a POrdinalKey can be used as a PINDEX value

oPINLINE PINDEX operator++()
Operator to pre-increment the ordinal

oPINLINE PINDEX operator++(int)
Operator to post-increment the ordinal

oPINLINE PINDEX operator--()
Operator to pre-decrement the ordinal

oPINLINE PINDEX operator--(int)
Operator to post-decrement the ordinal

oPINLINE POrdinalKey& operator+=(PINDEX)
Operator to add the ordinal

oPINLINE POrdinalKey& operator-=(PINDEX )
Operator to subtract from the ordinal


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.