Name 

Description 

IAimmsObject 

Base class for all objects representing an AIMMS identifier in the SDK. 

ICallBack 

Receiver of information and errors. Can be used to override the default error handling with the setCallBack method of ISession.
ICallback creation requires the creation of an instance of your own derived class. 

IConfig 

Object that represents the configuration for the SDK.
 

IData 

Base class that represents an AIMMS identifier that holds data.
Data objects can be created on the ISession, using openData, openSet, openScalar or openMultiDim. 

IDataView 

A view on multi-dimensional data.
Views can be created using openView, on an IMultiDimData. This method requires a filter that can be created using createFilter (on the IMultiDimData).
 

IElement 

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.

 

IFilter 

A helper class used to construct a view or a filtered iterator on multi-dimensional data.
Filters can be created using createFilter on an IMultiDimData.
 

IIterator 

Reads multi dimensional data in a sequential order.
Iterators can be created using createIterator on an IMultiDimData or IDataView. If created on the data itself , an IFilter may be specified.
 

IMultiDimData 

An object that represents the data of a multi-dimensional identifier in the AIMMS model.
Non-scalar data objects can be created using openMultiDim on the ISession.
Reference to multi dimensional data in the AIMMS model. 

IProcedure 

Represents a procedure (i.e. not a function) in an AIMMS model.
Procedure objects can be created using openProcedure on the ISession. 

IScalarData 

Represents a scalar value in the AIMMS model. This can be an actual scalar parameter/variable or an IDataView with dimension zero.
Scalar objects can be created using openScalar on the ISession. 

IScalarDataView 

Represents a scalar/zero-dimensional view on data.
Views can be created using openView on an IMultiDimData. This method requires a filter that can be created using createFilter (on the IMultiDimData).
If the resulting IDataView has dimension of zero, it can be cast to an IScalarDataView to gain access to more convenient methods for accessing the scalar data. 

ISession 

Represents a specific AIMMS session associated with a certain model.
Sessions can be created using the global function aimms::openSession. 

ISetData 

Represents the data of a set in the AIMMS model.
Set data objects can be created using openSet on the ISession. 

ISetIterator 

An object that allows you to iterate over the data associated with an ISetData object.
Set iterators can be created using createIterator on an ISetData.
 

ITuple 

Object that represents an AIMMS tuple. For a more convenient (but less efficient in terms of performance) variant see the Tuple class.
Tuples can be created using createTuple on an IMultiDimData, IDataView or IIterator.
 

Tuple 

Object that allows to conveniently represent an AIMMS tuple. Use the ITuple inerface instead when performance is an issue, or when the convenience Tuple, which has a maximum of 5 dimensions, is not enough.
Convenience tuples can be created using the constructors, which allow up to 5 labels as argument.
 

Name 

Description 

aimms 

The main factory methods that create the ISession or IConfig objects. 

Name 

Description 

Exceptions 

This section lists the exceptions that can be thrown by the SDK when no customized ICallBack is attached.