GenericKey Class Template Reference

Abstract class for keys that are not based on a standard data type. More...

#include <GenericKey.h>

List of all members.

Public Methods

virtual bool operator== (GenericKey< KEY, DATA > &key) const
 Return true if key equals the current key.

virtual bool operator< (GenericKey< KEY, DATA > &key) const
 Return true if the current key is less than key.

virtual bool operator> (GenericKey< KEY, DATA > &key) const
 Return true if the current key is greater than key.

virtual int compare (const GenericKey< KEY, DATA > &val) const
 Compare key with the current key, returning a value that is consistent with the standard comparison semantics. More...

virtual void write (ostream &os) const
 Write the key to an output stream.

virtual void read (istream &)
 Read the key from an input stream.

DATA & data ()
 Return a reference to the data.

KEY & key ()
 Return a reference to the key.

const KEY & key () const
 Return a const reference to the key.


Protected Attributes

KEY Key
 The key.

DATA Data
 The data.

Detailed Description

template<class KEY, class DATA>
class GenericKey< KEY, DATA >

Abstract class for keys that are not based on a standard data type.

Member Function Documentation

template<class KEY, class DATA>
virtual int GenericKey< KEY, DATA >::compare (  const GenericKey< KEY, DATA > &    val )  const [inline, virtual]
 

Compare key with the current key, returning a value that is consistent with the standard comparison semantics.

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