Skip to main content
FRAMES NO FRAMES

Class IloOplElement

Definition file: ilopl/ilooplelement.h
Map of IloOplElementIloOplElementIloOplElement
Element declared in an OPL model.

An instance of this class represents a named element in an OPL model. It provides access to data, decision variables, constraints, and solution values.

See Also:

Method Summary
public IloConstraintasConstraint() const
public IloConstraintMapasConstraintMap() const
public IloCumulFunctionExprasCumulFunctionExpr() const
public IloCumulFunctionExprMapasCumulFunctionExprMap() const
public IloDiscreteDataCollectionasDiscreteDataCollection() const
public IloIntasInt() const
public IloIntervalSequenceVarasIntervalSequenceVar() const
public IloIntervalSequenceVarMapasIntervalSequenceVarMap() const
public IloIntervalVarasIntervalVar() const
public IloIntervalVarMapasIntervalVarMap() const
public IloIntExprArgasIntExpr() const
public IloIntDExprMapasIntExprMap() const
public IloIntMapasIntMap() const
public IloIntRangeasIntRange() const
public IloIntSetasIntSet() const
public IloIntSetMapasIntSetMap() const
public IloIntVarasIntVar() const
public IloIntVarMapasIntVarMap() const
public IloNumasNum() const
public IloNumExprArgasNumExpr() const
public IloNumDExprMapasNumExprMap() const
public IloNumMapasNumMap() const
public IloNumRangeasNumRange() const
public IloNumSetasNumSet() const
public IloNumSetMapasNumSetMap() const
public IloNumVarasNumVar() const
public IloNumVarMapasNumVarMap() const
public IloPiecewiseFunctionExprasPiecewiseFunctionExpr() const
public IloPiecewiseFunctionExprMapasPiecewiseFunctionExprMap() const
public IloStateFunctionExprasStateFunctionExpr() const
public IloStateFunctionExprMapasStateFunctionExprMap() const
public const char *asString() const
public IloSymbolMapasSymbolMap() const
public IloSymbolSetasSymbolSet() const
public IloSymbolSetMapasSymbolSetMap() const
public IloTupleasTuple() const
public IloTupleMapasTupleMap() const
public IloTupleSchemaasTupleSchema() const
public IloTupleSetasTupleSet() const
public IloTupleSetMapasTupleSetMap() const
public voidend()
public IloOplElement::TypegetElementType() const
public IloOplLocationgetLocation() const
public const char *getName() const
public IloBoolisDecisionExpression() const
public IloBoolisDecisionVariable() const
public IloBoolisDiscreteDataCollection() const
public IloBoolisExternalData() const
public IloBoolisInternalData() const
public IloBoolisMap() const
public IloBoolisPostProcessing() const
Inner Typedef
IloOplElement::Type The possible element types.
Method Detail

asConstraint

public IloConstraint asConstraint() const

This member function retrieves the value of the element as a constraint.

Returns:

A constraint.

asConstraintMap

public IloConstraintMap asConstraintMap() const

This member function retrieves the value of the element as an array of constraints.

Returns:

An array of constraints.

asCumulFunctionExpr

public IloCumulFunctionExpr asCumulFunctionExpr() const

This member function retrieves the value of the element as a cumul function expression.

Returns:

A cumul function expression.

asCumulFunctionExprMap

public IloCumulFunctionExprMap asCumulFunctionExprMap() const

This member function retrieves the value of the element as a map of cumul function expression.

Returns:

A map cumul function expression.

asDiscreteDataCollection

public IloDiscreteDataCollection asDiscreteDataCollection() const

This member function retrieves the value of the element as a collection.

Returns:

A collection.

asInt

public IloInt asInt() const

This member function retrieves the integer value of the element. If the element is a decision variable, its value within the current solution is returned.

Returns:

The integer value of the element.

asIntervalSequenceVar

public IloIntervalSequenceVar asIntervalSequenceVar() const

This member function retrieves the value of the element as a decision variable of type interval sequence.

Returns:

An interval sequence decision variable.

asIntervalSequenceVarMap

public IloIntervalSequenceVarMap asIntervalSequenceVarMap() const

This member function retrieves the value of the element as an array of decision variables of type interval sequence.

Returns:

An array of interval sequence decision variables.

asIntervalVar

public IloIntervalVar asIntervalVar() const

This member function retrieves the value of the element as a decision variable of type interval.

Returns:

An interval decision variable.

asIntervalVarMap

public IloIntervalVarMap asIntervalVarMap() const

This member function retrieves the value of the element as an array of decision variables of type interval.

Returns:

An array of interval decision variables.

asIntExpr

public IloIntExprArg asIntExpr() const

This member function retrieves the value of the element as a decision expression of type integer.

Returns:

An integer decision expression.

asIntExprMap

public IloIntDExprMap asIntExprMap() const

This member function retrieves the value of the element as an array of decision expressions of type integer.

Returns:

An array of integer decision expressions.

asIntMap

public IloIntMap asIntMap() const

This member function retrieves the value of the element as an array of integers.

Returns:

An array of integers.

asIntRange

public IloIntRange asIntRange() const

This member function retrieves the value of the element as a range of integers.

Returns:

A range of integers.

asIntSet

public IloIntSet asIntSet() const

This member function retrieves the value of the element as a set of integers.

Returns:

A set of integers.

asIntSetMap

public IloIntSetMap asIntSetMap() const

This member function retrieves the value of the element as an array of integer sets.

Returns:

An array of integer sets.

asIntVar

public IloIntVar asIntVar() const

This member function retrieves the value of the element as a decision variable of type integer.

Returns:

An integer decision variable.

asIntVarMap

public IloIntVarMap asIntVarMap() const

This member function retrieves the value of the element as an array of decision variables of type integer.

Returns:

An array of integer decision variables.

asNum

public IloNum asNum() const

This member function retrieves the numeric value of the element. If the element is a decision variable, its value within the current solution is returned.

Returns:

The numeric value of the element.

asNumExpr

public IloNumExprArg asNumExpr() const

This member function retrieves the value of the element as a decision expression of type float.

Returns:

A float decision expression.

asNumExprMap

public IloNumDExprMap asNumExprMap() const

This member function retrieves the value of the element as an array of decision expressions of type float.

Returns:

An array of float decision expressions.

asNumMap

public IloNumMap asNumMap() const

This member function retrieves the value of the element as an array of floats.

Returns:

An array of floats.

asNumRange

public IloNumRange asNumRange() const

This member function retrieves the value of the element as a range of floating-point values.

Returns:

A range of floating-point values.

asNumSet

public IloNumSet asNumSet() const

This member function retrieves the value of the element as a set of floating-point values.

Returns:

A set of floating-point values.

asNumSetMap

public IloNumSetMap asNumSetMap() const

This member function retrieves the value of the element as an array of float sets.

Returns:

An array of float sets.

asNumVar

public IloNumVar asNumVar() const

This member function retrieves the value of the element as a decision variable of type float.

Returns:

A float decision variable.

asNumVarMap

public IloNumVarMap asNumVarMap() const

This member function retrieves the value of the element as an array of decision variables of type float.

Returns:

An array of float decision variables.

asPiecewiseFunctionExpr

public IloPiecewiseFunctionExpr asPiecewiseFunctionExpr() const

This member function retrieves the value of the element as a piecewise function.

Returns:

A piecewise function.

asPiecewiseFunctionExprMap

public IloPiecewiseFunctionExprMap asPiecewiseFunctionExprMap() const

This member function retrieves the value of the element as a piecewise function map.

Returns:

A piecewise function map.

asStateFunctionExpr

public IloStateFunctionExpr asStateFunctionExpr() const

This member function retrieves the value of the element as a state function expression.

Returns:

A state function expression.

asStateFunctionExprMap

public IloStateFunctionExprMap asStateFunctionExprMap() const

This member function retrieves the value of the element as a map of state function expression.

Returns:

A map state function expression.

asString

public const char * asString() const

This member function retrieves the value of the element as a string.

Returns:

A string.

asSymbolMap

public IloSymbolMap asSymbolMap() const

This member function retrieves the value of the element as an array of strings.

Returns:

An array of strings.

asSymbolSet

public IloSymbolSet asSymbolSet() const

This member function retrieves the value of the element as a set of strings.

Returns:

A set of strings.

asSymbolSetMap

public IloSymbolSetMap asSymbolSetMap() const

This member function retrieves the value of the element as an array of string sets.

Returns:

An array of string sets.

asTuple

public IloTuple asTuple() const

This member function retrieves the value of the element as a tuple.

Returns:

A tuple.

asTupleMap

public IloTupleMap asTupleMap() const

This member function retrieves the value of the element as an array of tuples.

Returns:

An array of tuples.

asTupleSchema

public IloTupleSchema asTupleSchema() const

This member function retrieves the value of the element as a schema of tuple sets.

Returns:

A schema of tuple sets.

asTupleSet

public IloTupleSet asTupleSet() const

This member function retrieves the value of the element as a set of tuples.

Returns:

A set of tuples.

asTupleSetMap

public IloTupleSetMap asTupleSetMap() const

This member function retrieves the value of the element as an array of tuple sets.

Returns:

An array of tuple sets.

end

public void end()

Clears the memory used by this object


getElementType

public IloOplElement::Type getElementType() const

This member function retrieves the OPL type of the element.

Returns:

The OPL type of the element.

getLocation

public IloOplLocation getLocation() const

This member function retrieves the source location at which the element was declared.

Returns:

An IloOplLocation representing the source location of the element.

getName

public const char * getName() const

This member function retrieves the name of the element.

Returns:

A char representing the name of the element.

isDecisionExpression

public IloBool isDecisionExpression() const

This member function enables you to know whether the element is a decision expression.

Returns:

IloTrue if the element is a decision expression.

isDecisionVariable

public IloBool isDecisionVariable() const

This member function enables you to know whether the element is a decision variable.

Returns:

IloTrue if the element is a decision variable.

isDiscreteDataCollection

public IloBool isDiscreteDataCollection() const

This member function enables you to know whether the element is a discrete data collection.

Returns:

IloTrue if the element is a discrete data collection.

isExternalData

public IloBool isExternalData() const

This member function enables you to know whether the element is data that is external to the model.

The return value indicates whether the data is from an external data source.

See Also:

Returns:

IloTrue if the element is data from a data source.

isInternalData

public IloBool isInternalData() const

This member function enables you to know whether the element is data that is initialized in the model.

The return value indicates whether the data is internal data.

See Also:

Returns:

IloTrue if the element is internal data.

isMap

public IloBool isMap() const

This member function enables you to know whether the element is a map.

Returns:

IloTrue if the element is a map.

isPostProcessing

public IloBool isPostProcessing() const

This member function enables you to know whether the element is in postprocessing.

Returns:

IloTrue if the element is in postprocessing.

Inner Typedef Detail

Typedef Type

Definition file: ilopl/ilooplelement.h

IloOplElementType::Type Type

The possible element types.

This type definition defines possible element types.

See Also: