Entry identifier class for items of a DataSet.Every item in a DataSet is assigned a DataKey by which it can be accessed (using DataSet::operator[]()). A DataKey consists of an integer member idx, which is a positive number for any valid DataKey. No idx of an element in a DataSet may exceed the sets max(). This property may be used to build arrays with additional information to the elements of a DataSet. More...

#include <datakey.h>

Inheritance diagram for DataKey:

[legend]

Public Member Functions
Constructors / destructors
	DataKey ()
	Default constructor. Constructs an invalid DataKey.

	DataKey (int p_info, int p_idx)

DataKey &	operator= (const DataKey &rhs)
	Assignment operator.

	DataKey (const DataKey &old)
	Copy constructor.

Access / modification
int	getIdx () const
	gets the index number (idx) of the DataKey.

void	setIdx (int p_idx)
	sets the index number (idx) of the DataKey.

int	isValid () const
	returns TRUE, iff the DataKey is valid.

void	inValidate ()
	makes the DataKey invalid and clears the info field.

Public Attributes
Data
int	info
	user information to store values -1, 0, +1

int	idx
	(locally) unique key index

Detailed Description

Entry identifier class for items of a DataSet.

Every item in a DataSet is assigned a DataKey by which it can be accessed (using DataSet::operator[]()). A DataKey consists of an integer member idx, which is a positive number for any valid DataKey. No idx of an element in a DataSet may exceed the sets max(). This property may be used to build arrays with additional information to the elements of a DataSet.

In addition, DataKeys provide a member info which can be used to store further information.

Each DataKey is unique for one DataSet but different DataSets may (and generally will) manage the same DataKeys. When an element is removed from a DataSet its DataKey may (and generally will) be reused for other elements added to the DataSet later on.