This class is used when an ordinal index value is the key for PSet and PDictionary classes
Inheritance:
Public Methods
| Construction
|
| Overrides from class PObject
|
| 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
Construction
PINLINE POrdinalKey( PINDEX newKey = 0 )
- Create a new key for ordinal index values.
- Parameters:
- newKey - Ordinal index value to use as a key.
PINLINE POrdinalKey& operator=(PINDEX)
- Operator to assign the ordinal
Overrides from class PObject
virtual PObject* Clone() const
- Create a duplicate of the POrdinalKey
virtual PINDEX HashFunction() const
- This function calculates a hash table index value for the implementation
of PSet and PDictionary classes.
- Returns:
- hash table bucket number.
virtual 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.
New functions for class
PINLINE operator PINDEX() const
- Operator so that a POrdinalKey can be used as a PINDEX value
PINLINE PINDEX operator++()
- Operator to pre-increment the ordinal
PINLINE PINDEX operator++(int)
- Operator to post-increment the ordinal
PINLINE PINDEX operator--()
- Operator to pre-decrement the ordinal
PINLINE PINDEX operator--(int)
- Operator to post-decrement the ordinal
PINLINE POrdinalKey& operator+=(PINDEX)
- Operator to add the ordinal
PINLINE 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++.