Name 

Description 

 

OrdinalUndefined 

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

 

Name 

Description 

 

add 

Adds the specified integer- or string label to the set and all of its super sets. 

 

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.
 

 

clone 

Returns a reference to a new IElement with the same content.
 

 

close 

Closes and invalidates this IElement. 

 

copy 

Copies the content of the source IElement to this IElement.
 

 

getIntLabel 

Returns the integer label of this IElement. Does only apply to IElements associated with subsets of Integers.
 

 

getLabel 

Returns the string label of this IElement. Does only apply to IElements not associated with subsets of Integers.
 

 

getOrdinal 

Returns the ordinal position in the associated set of this IElement. In case of an error, the constant OrdinalUndefined is returned.
 

 

isEmpty 

Returns whether this IElement is set to the empty Element (i.e. '' in the AIMMS language).
 

 

isReadonly 

Returns whether this IElement is read only. Read only IElements cannot be set to another value or closed. This occurs e.g. when querying the IElement associated with a certain position in an IDataView object. The returned IElement object cannot be assigned a value, because that value should be assigned to the IDataView object instead.
 

 

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.
 

 

setEmpty 

Sets this IElement 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.
 

 

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.