IElement Class

Represents a single element of an AIMMS set.

Elements can be created in several ways:

As part of an ITuple (using createTuple on an IMultiDimData, an IDataView or an IIterator).
Using createElement on an ISetData or ISetIterator.
Using createElementValue on an element-valued IMultiDimData, IDataView or IIterator.

C++

class IElement;

Inheritance Hierarchy

Module

C++

Topics

Name	Description
IElement Members	The following tables list the members exposed by IElement.

Public Methods

	Name	Description
	getIntLabel	Retrieves the integer label corresponding to the current element position.
	getLabel	Retrieves the label corresponding to the current element position.
	getOrdinal	Retrieves the ordinal corresponding to the current element position.
	check_setIntLabel	Attempts to assign the specified integer label to this IElement. Returns true if the assignment succeeded, returns false when the integer label does not exist in the associated subset of Integers.
	check_setLabel	Attempts to assign the specified string label to this IElement. Returns true if the assignment succeeded, returns false when the integer label does not exist in the associated set. Only applies to IElements not associated with a subset of integers.
	check_setOrdinal	Attempts to assign the specified position in the associated set to this IElement. Returns true if the assignment succeeded, returns false when the ordinal position is invalid.
	close	Closes and invalidates this IElement.
	add	Adds the label to the set and all its parent sets.
	clone	Returns a reference to a new IElement with the same content.
	nocheck_setIntLabel	Assigns the specified integer label to this IElement without checking, as opposed to its counterparts setIntLabel and check_setIntLabel. This function may cause an error at a later stage if the label is not in the set and this IElement was used to assign some value into an IData object.
	nocheck_setLabel	Assigns the specified string label to this IElement without checking whether this label is part of the associated set, as opposed to its counterparts setLabel and check_setLabel. This method does raise an RuntimeException if the label does not exist in the root set. This method does not apply to IElements over subsets of Integers. This function may cause an error at a later stage if the label is not in the Set and the element is added as a position or value in some IData.
	copy	Copies the content of the source IElement to this IElement.
	printLabel	Prints the label to the stream.
	isEmpty	Returns whether this IElement is set to the empty Element (i.e. '' in the AIMMS language).
	setIntLabel	Assigns the specified integer label to this IElement. This method does only apply to IElements associated with a subset of Integers.
	setEmpty	Sets this IElement to the empty Element (i.e. '' in the AIMMS language).
	setLabel	Assigns the specified string label to this IElement. This method does not apply to IElements associated with a subset of Integers. A RuntimeException is raised if the label does not exist in the root set.
	setOrdinal	Assigns the specified position in the set associated with this IElement to this IElement. A RuntimeException is raised if the ordinal position does not exist in the set.

Variables

Name	Description
OrdinalUndefined	Return value for ordinals in erroneous cases. This value might be returned when invoking e.g. the getOrdinal() member-method.

Public Operators

	Name	Description
	=	Provides some quick setting.
	const char*	Returns the string label. Does not apply to elements on (a subset of) Integers.