This abstract class defines the interface that a contained object must support if it has comparable key associated with it. More...

Detailed Description

This abstract class defines the interface that a contained object must support if it has comparable key associated with it.

#include <Key.h>

Inheritance diagram for Cpl::Container::Key:

[legend]

Public Member Functions
virtual	~Key ()
	Ensure a Virtual destructor.

virtual int	compareKey (const Key &key) const =0
	Key Compare function.

virtual const void *	getRawKey (unsigned *returnRawKeyLenPtr=0) const =0
	Returns the object's length (in bytes) and point to the start of key data.

Constructor & Destructor Documentation

◆ ~Key()

virtual Cpl::Container::Key::~Key ( )

inlinevirtual

Ensure a Virtual destructor.

Member Function Documentation

◆ compareKey()

virtual int Cpl::Container::Key::compareKey ( const Key & key ) const

pure virtual

Key Compare function.

Returns <0, 0, >0 if this key is less than, equal, or greater than respectively to the specified key! The actual type of the 'key' is up to the client sub-class that implements this interface. It is the responsibility of the sub-class to correctly define/interpret the data type of the key.

Implemented in Cpl::Container::KeyPlainType< DATATYPE >, and Cpl::Container::KeyStringBuffer.

◆ getRawKey()

virtual const void * Cpl::Container::Key::getRawKey ( unsigned * returnRawKeyLenPtr = 0 ) const

pure virtual

Returns the object's length (in bytes) and point to the start of key data.

If 'returnRawKeyLenPtr' is null, then no length is returned.

Implemented in Cpl::Container::KeyPlainType< DATATYPE >, Cpl::Container::KeyStringBuffer, and Cpl::Text::String_.

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