A key includes zero or one elements in each dimension. More...

#include <DataKey.h>

Public Member Functions
	DataKey ()
	Create empty key. More...

	DataKey (const DataKeyElement &element)
	Create single element key. More...

	DataKey (const DataKeyElement &element1, const DataKeyElement &element2)
	Create two element key. More...

	DataKey (const DataKeyElement &element1, const DataKeyElement &element2, const DataKeyElement &element3)
	Create three element key. More...

	DataKey (const std::set< DataKeyElement > &elements)
	Create multiple element key. More...

	DataKey (const DataKey &key)

std::set< DataKeyDimension >	getDimensions () const

size_t	getElementCount () const

bool	hasDimension (const DataKeyDimension &dim) const

bool	hasElement (const DataKeyElement &element) const

std::set< DataKeyElement >	getElements () const

DataKeyElement	getElement (const DataKeyDimension &dim) const

std::string	str () const

std::string	toName (const std::string &delim) const
	Generate a unique name from this key. More...

	~DataKey ()

DataKey &	operator= (const DataKey &key)

bool	operator== (const DataKey &key) const

bool	operator!= (const DataKey &key) const

bool	operator< (const DataKey &key) const

Detailed Description

A key includes zero or one elements in each dimension.

Instances are immutable.

Constructor & Destructor Documentation

BUSBOY::DataKey::DataKey ( )

Create empty key.

This is useful for keying global data, such as the single end result of an algorithm.

BUSBOY::DataKey::DataKey ( const DataKeyElement & element )

Create single element key.

Create two element key.

Create three element key.

BUSBOY::DataKey::DataKey ( const std::set< DataKeyElement > & elements )

Create multiple element key.

BUSBOY::DataKey::DataKey ( const DataKey & key )

BUSBOY::DataKey::~DataKey ( )

std::set< DataKeyDimension > BUSBOY::DataKey::getDimensions ( ) const

DataKeyElement BUSBOY::DataKey::getElement ( const DataKeyDimension & dim ) const

size_t BUSBOY::DataKey::getElementCount ( ) const

std::set< DataKeyElement > BUSBOY::DataKey::getElements ( ) const

bool BUSBOY::DataKey::hasDimension ( const DataKeyDimension & dim ) const

bool BUSBOY::DataKey::hasElement ( const DataKeyElement & element ) const

bool BUSBOY::DataKey::operator!= ( const DataKey & key ) const

bool BUSBOY::DataKey::operator< ( const DataKey & key ) const

DataKey & BUSBOY::DataKey::operator= ( const DataKey & key )

bool BUSBOY::DataKey::operator== ( const DataKey & key ) const

std::string BUSBOY::DataKey::str ( ) const

std::string BUSBOY::DataKey::toName ( const std::string & delim ) const

Generate a unique name from this key.

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