Contents
Introduction
Typical Usage
Comparison with API
Installation
Windows
Linux
Getting Started
Java
Java using Maven and Netbeans
C#
C# using Visual Studio
C++
C++ using Visual Studio
Tutorial
Opening and closing an AIMMS session
Inserting data into an identifier
Running a procedure
Retrieving data
Worked out example
Java
Basic.java
Main.java
C++
basic.cpp
C#
Program.cs
Basic.cs
Using the SDK
Reuse of tuples
Data Views
Dense data assignment
Ordinals
Optimizing performance
Thread safety
AIMMS feature support
Tuning configuration settings
Character encoding
Examples
Views
C++
Java
C#
Callback
C++
C#
Callback.java
Procedure with arguments
C++
Java
C#
Performance
C++
Java
C#
Pitfalls
C++
Java
C#
Use Cases
Fortran AimmsLink
Deployment
Standalone
C++
Java
C#
Host Files
Client
C++
Java
C#
Server
Installation
Running a remote session
Configuration
Default Rules
Creating Rules
Providing the AIMMS image
Troubleshooting
SSL
C++
Java
Language references
Java
AIMMS Class
AIMMS Members
AIMMS.createDefaultConfig Method
openSession Method
AIMMS.openSession Method (String, String)
AIMMS.openSession Method (String, String, IConfig)
AIMMS.openSessionExt Method
Exceptions
AimmsException Class
AimmsException Members
AimmsException.AimmsException Constructor
AimmsException.which Method
AimmsCommunicationException Class
AimmsCommunicationException Members
AimmsCommunicationException.AimmsCommunicationException Constructor
AimmsInvalidUseException Class
AimmsInvalidUseException Members
AimmsInvalidUseException.AimmsInvalidUseException Constructor
AimmsLicenseException Class
AimmsLicenseException Members
AimmsLicenseException.AimmsLicenseException Constructor
AimmsRuntimeException Class
AimmsRuntimeException Members
AimmsRuntimeException.AimmsRuntimeException Constructor
AimmsMessage Class
AimmsMessage Members
AimmsMessage.code Field
AimmsMessage.message Field
IAimmsObject Interface
IAimmsObject Members
IAimmsObject.close Method
IAimmsObject.getName Method
ICallBack Interface
ICallBack Members
ICallBack.onMessages Method
IConfig Interface
IConfig Members
IConfig.getAimmsCommandLine Method
IConfig.getCommunicationConfig Method
IConfig.getConnectTimeout Method
IConfig.getHostCommandLine Method
IConfig.getHostFolder Method
IConfig.getHostLoggerConfigFileName Method
IConfig.getMaxBufferSize Method
IConfig.getMaxFlush Method
IConfig.getMaxTransmitSize Method
IConfig.getTimeout Method
IConfig.getWaitForProcedureCancel Method
IConfig.setAimmsCommandLine Method
IConfig.setCommunicationConfig Method
IConfig.setConnectTimeout Method
IConfig.setHostCommandLine Method
IConfig.setHostFolder Method
IConfig.setHostLoggerConfigFileName Method
IConfig.setMaxBufferSize Method
IConfig.setMaxFlush Method
IConfig.setMaxTransmitSize Method
IConfig.setTimeout Method
IConfig.setWaitForProcedureCancel Method
IData Interface
IData Members
IData.empty Method
IData.getCardinality Method
IData.getDimension Method
IData.getType Method
IData.getValueType Method
IDataView Interface
IDataView Members
IDataView.createElementValue Method
createIterator Method
IDataView.createIterator Method ()
IDataView.createIterator Method (int)
IDataView.createTuple Method
IDataView.flush Method
getDouble Method
IDataView.getDouble Method (ITuple)
IDataView.getDouble Method (Tuple)
getElement Method
IDataView.getElement Method (ITuple)
IDataView.getElement Method (Tuple)
IDataView.getIndexDomain Method
getInt Method
IDataView.getInt Method (ITuple)
IDataView.getInt Method (Tuple)
getString Method
IDataView.getString Method (ITuple)
IDataView.getString Method (Tuple)
insert Method
IDataView.insert Method (Tuple, IElement)
IDataView.insert Method (Tuple, String)
IDataView.insert Method (Tuple, String, boolean)
IDataView.insert Method (Tuple, double)
IDataView.insert Method (Tuple, int)
IDataView.insert Method (Tuple, int, boolean)
setValue Method
IDataView.setValue Method (ITuple, IElement)
IDataView.setValue Method (ITuple, String)
IDataView.setValue Method (ITuple, double)
IDataView.setValue Method (ITuple, int)
IDataView.setValue Method (Tuple, IElement)
IDataView.setValue Method (Tuple, String)
IDataView.setValue Method (Tuple, double)
IDataView.setValue Method (Tuple, int)
setValues Method
IDataView.setValues Method (String...)
IDataView.setValues Method (double...)
IDataView.setValues Method (int...)
setValuesCMO Method
IDataView.setValuesCMO Method (String...)
IDataView.setValuesCMO Method (double...)
IDataView.setValuesCMO Method (int...)
IDataView.tupleCompatible Method
IDataView.tupleValid Method
IElement Interface
IElement Members
IElement.OrdinalUndefined Field
add Method
IElement.add Method (String)
IElement.add Method (int)
IElement.check_setIntLabel Method
IElement.check_setLabel Method
IElement.check_setOrdinal Method
IElement.clone Method
IElement.close Method
IElement.copy Method
IElement.getIntLabel Method
IElement.getLabel Method
IElement.getOrdinal Method
IElement.isEmpty Method
IElement.isReadonly Method
IElement.nocheck_setIntLabel Method
IElement.nocheck_setLabel Method
IElement.setEmpty Method
IElement.setIntLabel Method
IElement.setLabel Method
IElement.setOrdinal Method
IFilter Interface
IFilter Members
IFilter.close Method
restrict Method
IFilter.restrict Method (int, IElement)
IFilter.restrict Method (int, ISetData)
IFilter.restrict Method (int, String)
IFilter.restrict Method (int, int)
IFilter.toString Method
IIterator Interface
IIterator Members
IIterator.asDouble Method
IIterator.asElement Method
IIterator.asInt Method
IIterator.asString Method
IIterator.close Method
IIterator.createTuple Method
IIterator.getDimension Method
IIterator.getTuple Method
IIterator.next Method
IIterator.reset Method
IIterator.tuple Method
IIterator.tupleValid Method
IMultiDimData Interface
IMultiDimData Members
IMultiDimData.createFilter Method
createIterator Method
IMultiDimData.createIterator Method (IFilter)
IMultiDimData.createIterator Method (IFilter, int)
IMultiDimData.openView Method
IMultiDimData.sync Method
IProcedure Interface
IProcedure Members
IProcedure.abort Method
IProcedure.getArgument Method
IProcedure.getNumberOfArguments Method
run Method
IProcedure.run Method (IData...)
IProcedure.run Method (int, IData...)
IScalarData Interface
IScalarData Members
IScalarData.asDouble Method
IScalarData.asElement Method
IScalarData.asInt Method
IScalarData.asString Method
IScalarData.createElementValue Method
setValue Method
IScalarData.setValue Method (IElement)
IScalarData.setValue Method (String)
IScalarData.setValue Method (double)
IScalarData.setValue Method (int)
IScalarDataView Interface
ISession Interface
ISession Members
ISession.clearBuffers Method
ISession.close Method
ISession.closeAllData Method
ISession.getConfig Method
ISession.openData Method
ISession.openMultiDim Method
ISession.openProcedure Method
ISession.openScalar Method
ISession.openSet Method
ISession.setCallBack Method
updateData Method
ISession.updateData Method ()
ISession.updateData Method (List<IData>, int)
ISession.updateData Method (int)
ISetData Interface
ISetData Members
add Method
ISetData.add Method (IElement)
ISetData.add Method (String)
ISetData.add Method (int)
appendLabels Method
ISetData.appendLabels Method (String...)
ISetData.appendLabels Method (int...)
contains Method
ISetData.contains Method (IElement)
ISetData.contains Method (String)
ISetData.contains Method (int)
ISetData.createElement Method
ISetData.createIterator Method
ISetData.elementCompatible Method
remove Method
ISetData.remove Method (IElement)
ISetData.remove Method (String)
ISetData.remove Method (int)
setLabels Method
ISetData.setLabels Method (String...)
ISetData.setLabels Method (int...)
ISetIterator Interface
ISetIterator Members
ISetIterator.close Method
ISetIterator.createElement Method
ISetIterator.element Method
ISetIterator.elementCompatible Method
ISetIterator.getElement Method
ISetIterator.next Method
ISetIterator.reset Method
ITuple Interface
ITuple Members
ITuple.clone Method
ITuple.close Method
ITuple.copy Method
ITuple.getDimension Method
ITuple.getElement Method
ITuple.isReadonly Method
ITuple.isValid Method
ITuple.setTuple Method
Tuple Class
Tuple Members
Tuple.toString Method
Tuple.Tuple Constructor
C#
AIMMS Class
AIMMS Members
AIMMS.createDefaultConfig Method
openSession Method
AIMMS.openSession Method (string, string)
AIMMS.openSession Method (string, string, IConfig)
Exceptions
AimmsException Class
AimmsException Members
AimmsException.AimmsException Constructor
AimmsException.which Method
AimmsCommunicationException Class
AimmsCommunicationException Members
AimmsCommunicationException.AimmsCommunicationException Constructor
AimmsInvalidUseException Class
AimmsInvalidUseException Members
AimmsInvalidUseException.AimmsInvalidUseException Constructor
AimmsLicenseException Class
AimmsLicenseException Members
AimmsLicenseException.AimmsLicenseException Constructor
AimmsRuntimeException Class
AimmsRuntimeException Members
AimmsRuntimeException.AimmsRuntimeException Constructor
AimmsMessage Class
AimmsMessage Members
AimmsMessage.Code Property
AimmsMessage.Message Property
Aimms.AimmsMessageCode Enumeration
IAimmsObject Interface
IAimmsObject Members
IAimmsObject.Name Property
IAimmsObject.close Method
ICallBack Interface
ICallBack Members
ICallBack.onMessages Method
IConfig Interface
IConfig Members
IConfig.AimmsCommandLine Property
IConfig.CommunicationConfig Property
IConfig.ConnectTimeout Property
IConfig.HostCommandLine Property
IConfig.HostFolder Property
IConfig.HostLogConfigFileName Property
IConfig.InitLogger Property
IConfig.LogConfigFileName Property
IConfig.LogFileName Property
IConfig.MaxBufferSize Property
IConfig.MaxFlush Property
IConfig.MaxTransmitSize Property
IConfig.Timeout Property
IConfig.WaitForProcedureCancel Property
IConfig.clone Method
IData Interface
IData Members
IData.Cardinality Property
IData.Dimension Property
IData.DataType Property
IData.empty Method
Aimms.DataType Enumeration
IData.ValueType Property
Aimms.ValueType Enumeration
IDataView Interface
IDataView Members
IDataView.createElementValue Method
createIterator Method
IDataView.createIterator Method ()
IDataView.createIterator Method (int)
IDataView.createTuple Method
IDataView.flush Method
getDouble Method
IDataView.getDouble Method (ITuple)
IDataView.getDouble Method (Tuple)
getElement Method
IDataView.getElement Method (ITuple)
IDataView.getElement Method (Tuple)
IDataView.getIndexDomain Method
getInt Method
IDataView.getInt Method (ITuple)
IDataView.getInt Method (Tuple)
getString Method
IDataView.getString Method (ITuple)
IDataView.getString Method (Tuple)
insert Method
IDataView.insert Method (Tuple, IElement)
IDataView.insert Method (Tuple, String)
IDataView.insert Method (Tuple, String, bool)
IDataView.insert Method (Tuple, double)
IDataView.insert Method (Tuple, int)
IDataView.insert Method (Tuple, int, bool)
setValue Method
IDataView.setValue Method (ITuple, IElement)
IDataView.setValue Method (ITuple, String)
IDataView.setValue Method (ITuple, double)
IDataView.setValue Method (ITuple, int)
IDataView.setValue Method (Tuple, IElement)
IDataView.setValue Method (Tuple, String)
IDataView.setValue Method (Tuple, double)
IDataView.setValue Method (Tuple, int)
setValues Method
IDataView.setValues Method (params String[])
IDataView.setValues Method (params double[])
IDataView.setValues Method (params int[])
setValuesCMO Method
IDataView.setValuesCMO Method (params String[])
IDataView.setValuesCMO Method (params double[])
IDataView.setValuesCMO Method (params int[])
IDataView.tupleCompatible Method
IDataView.tupleValid Method
IElement Interface
IElement Members
add Method
IElement.add Method (String)
IElement.add Method (int)
IElement.check_setIntLabel Method
IElement.check_setLabel Method
IElement.check_setOrdinal Method
IElement.close Method
IElement.IntLabel Property
IElement.Label Property
IElement.nocheck_setIntLabel Method
IElement.nocheck_setLabel Method
IElement.clone Method
IElement.isEmpty Method
IElement.Ordinal Property
IElement.copy Method
IElement.Readonly Property
IElement.setEmpty Method
IFilter Interface
IFilter Members
IFilter.close Method
restrict Method
IFilter.restrict Method (int, IElement)
IFilter.restrict Method (int, ISetData)
IFilter.restrict Method (int, int)
IFilter.restrict Method (int, string)
IFilter.ToString Method
IIterator Interface
IIterator Members
IIterator.Dimension Property
IIterator.Double Property
IIterator.Element Property
IIterator.Int Property
IIterator.String Property
IIterator.Tuple Property
IIterator.close Method
IIterator.createTuple Method
IIterator.getTuple Method
IIterator.next Method
IIterator.reset Method
IIterator.this Indexer
IIterator.tupleValid Method
IMultiDimData Interface
IMultiDimData Members
IMultiDimData.createFilter Method
createIterator Method
IMultiDimData.createIterator Method (IFilter)
IMultiDimData.createIterator Method (IFilter, int)
IMultiDimData.openView Method
IMultiDimData.sync Method
IProcedure Interface
IProcedure Members
IProcedure.abort Method
IProcedure.getArgument Method
IProcedure.getNumberOfArguments Method
run Method
IProcedure.run Method (int, params IData[])
IProcedure.run Method (params IData[])
IScalarData Interface
IScalarData Members
IScalarData.Double Property
IScalarData.Element Property
IScalarData.Int Property
IScalarData.String Property
IScalarData.createElementValue Method
setValue Method
IScalarData.setValue Method (IElement)
IScalarData.setValue Method (String)
IScalarData.setValue Method (double)
IScalarData.setValue Method (int)
IScalarDataView Interface
ISession Interface
ISession Members
ISession.clearBuffers Method
ISession.close Method
ISession.closeAllData Method
ISession.getConfig Method
ISession.openData Method
ISession.openMultiDim Method
ISession.openProcedure Method
ISession.openScalar Method
ISession.openSet Method
ISession.setCallBack Method
updateData Method
ISession.updateData Method ()
ISession.updateData Method (IList<IData>, int)
ISession.updateData Method (int)
ISetData Interface
ISetData Members
add Method
ISetData.add Method (IElement)
ISetData.add Method (String)
ISetData.add Method (int)
appendLabels Method
ISetData.appendLabels Method (params String[])
ISetData.appendLabels Method (params int[])
contains Method
ISetData.contains Method (IElement)
ISetData.contains Method (String)
ISetData.contains Method (int)
ISetData.createElement Method
ISetData.createIterator Method
ISetData.elementCompatible Method
remove Method
ISetData.remove Method (IElement)
ISetData.remove Method (String)
ISetData.remove Method (int)
setLabels Method
ISetData.setLabels Method (params String[])
ISetData.setLabels Method (params int[])
ISetIterator Interface
ISetIterator Members
ISetIterator.element Property
ISetIterator.close Method
ISetIterator.createElement Method
ISetIterator.elementCompatible Method
ISetIterator.getElement Method
ISetIterator.next Method
ISetIterator.reset Method
ITuple Interface
ITuple Members
ITuple.Dimension Property
ITuple.Readonly Property
ITuple.clone Method
ITuple.close Method
ITuple.copy Method
ITuple.isValid Method
ITuple.setTuple Method
ITuple.this Indexer
Tuple Class
Tuple Members
Tuple.ToString Method
Tuple.Tuple Constructor
C++
aimms Namespace
Open Session
aimms::openSession Function
aimms::openSession Function
aimms::createDefaultConfig Function
aimms::openSessionExt Function
Exceptions
Exception Class
Exception::which Method
CommunicationException Class
InvalidUseException Class
LicenseException Class
RuntimeException Class
aimms::AimmsMessage Structure
aimms::AimmsMessageCode Enumeration
IAimmsObject Class
IAimmsObject::getName Method
IAimmsObject::close Method
ICallBack Class
ICallBack::onMessages Method
IConfig Class
IConfig::clone Method
IConfig::getAimmsCommandLine Method
IConfig::getCharacterEncoding Method
IConfig::getCommunicationConfig Method
IConfig::getConnectTimeout Method
IConfig::getHostCommandLine Method
IConfig::getHostFolder Method
IConfig::getHostLogConfigFileName Method
IConfig::getInitLogger Method
IConfig::getLogConfigFileName Method
IConfig::getLogFileName Method
IConfig::getMaxBufferSize Method
IConfig::getMaxFlush Method
IConfig::getMaxTransmitSize Method
IConfig::getTimeout Method
IConfig::getWaitForProcedureCancel Method
IConfig::setAimmsCommandLine Method
IConfig::setCharacterEncoding Method
IConfig::setCommunicationConfig Method
IConfig::setConnectTimeout Method
IConfig::setCurrentLocaleCharacterEncoding Method
IConfig::setHostCommandLine Method
IConfig::setHostFolder Method
IConfig::setHostLogConfigFileName Method
IConfig::setInitLogger Method
IConfig::setLogConfigFileName Method
IConfig::setLogFileName Method
IConfig::setMaxBufferSize Method
IConfig::setMaxFlush Method
IConfig::setMaxTransmitSize Method
IConfig::setTimeout Method
IConfig::setWaitForProcedureCancel Method
IData Class
aimms::ValueType Enumeration
aimms::DataType Enumeration
IData Members
IData::empty Method
IData::getCardinality Method
IData::getDimension Method
IData::getType Method
IData::getValueType Method
IDataView Class
IDataView Members
IDataView::createElementValue Method
IDataView::createIterator Method
IDataView::createTuple Method
IDataView::flush Method
getDouble Method
IDataView::getDouble Method (ITuple*)
IDataView::getDouble Method (Tuple&)
getElement Method
IDataView::getElement Method (ITuple*)
IDataView::getElement Method (Tuple&)
IDataView::getIndexDomain Method
getInt Method
IDataView::getInt Method (ITuple*)
IDataView::getInt Method (Tuple&)
getString Method
IDataView::getString Method (ITuple*)
IDataView::getString Method (Tuple&)
insert Method
IDataView::insert Method (Tuple&, IElement*)
IDataView::insert Method (Tuple&, char*, bool)
IDataView::insert Method (Tuple&, double)
IDataView::insert Method (Tuple&, int, bool)
setValue Method
IDataView::setValue Method (ITuple*, IElement*)
IDataView::setValue Method (ITuple*, char*)
IDataView::setValue Method (ITuple*, double)
IDataView::setValue Method (ITuple*, int)
IDataView::setValue Method (Tuple&, IElement*)
IDataView::setValue Method (Tuple&, char*)
IDataView::setValue Method (Tuple&, double)
IDataView::setValue Method (Tuple&, int)
setValues Method
IDataView::setValues Method (char* const, int)
IDataView::setValues Method (double, int)
IDataView::setValues Method (int, int)
IDataView::setValues Method (std::string, int)
setValuesCMO Method
IDataView::setValuesCMO Method (char* const, int)
IDataView::setValuesCMO Method (double, int)
IDataView::setValuesCMO Method (int, int)
IDataView::setValuesCMO Method (std::string, int)
IDataView::tupleCompatible Method
IDataView::tupleValid Method
IElement Class
aimms::OrdinalUndefined Variable
IElement Members
= Operator
IElement::= Operator (char*)
IElement::= Operator (int&)
getIntLabel Method
IElement::getIntLabel Method (int&)
IElement::getIntLabel Method ()
getLabel Method
IElement::getLabel Method (std::string&)
IElement::getLabel Method ()
getOrdinal Method
IElement::getOrdinal Method (int&)
IElement::getOrdinal Method ()
IElement::check_setIntLabel Method
IElement::check_setLabel Method
IElement::check_setOrdinal Method
IElement::close Method
add Method
IElement::add Method (char*)
IElement::add Method (int)
IElement::clone Method
IElement::const char* Operator
IElement::nocheck_setIntLabel Method
IElement::nocheck_setLabel Method
IElement::copy Method
IElement::printLabel Method
IElement::isEmpty Method
IElement::setIntLabel Method
IElement::setEmpty Method
IElement::setLabel Method
IElement::setOrdinal Method
IFilter Class
IFilter Members
IFilter::close Method
IFilter::print Method
restrict Method
IFilter::restrict Method (int, IElement*)
IFilter::restrict Method (int, ISetData*)
IFilter::restrict Method (int, char*)
IFilter::restrict Method (int, int)
IFilter::toString Method
IIterator Class
IIterator Members
IIterator::[] Operator
IIterator::tupleValid Method
IIterator::asCString Method
IIterator::asDouble Method
IIterator::asElement Method
IIterator::asInt Method
IIterator::getTuple Method
IIterator::asString Method
IIterator::close Method
IIterator::createElementValue Method
IIterator::createTuple Method
IIterator::getDimension Method
getValue Method
IIterator::getValue Method (IElement*)
IIterator::getValue Method (double&)
IIterator::getValue Method (int&)
IIterator::getValue Method (std::string&)
IIterator::next Method
IIterator::reset Method
IIterator::tuple Method
IMultiDimData Class
IMultiDimData Members
IMultiDimData::createFilter Method
IMultiDimData::createIterator Method
IMultiDimData::openView Method
IMultiDimData::sync Method
IProcedure Class
IProcedure Members
IProcedure::abort Method
IProcedure::getArgument Method
IProcedure::getNumberOfArguments Method
run Method
IProcedure::run Method (IData*, IData*, IData*, IData*, IData*, IData*, IData*, IData*, int)
IProcedure::run Method (std::vector<IData*>&, int)
IScalarData Class
= Operator
IScalarData::= Operator (char*)
IScalarData::= Operator (class IElement*)
IScalarData::= Operator (double&)
IScalarData::= Operator (int&)
IScalarData Members
IScalarData::asDouble Method
IScalarData::asElement Method
IScalarData::asInt Method
IScalarData::asString Method
IScalarData::createElementValue Method
getValue Method
IScalarData::getValue Method (IElement*)
IScalarData::getValue Method (double&)
IScalarData::getValue Method (int&)
IScalarData::getValue Method (std::string&)
setValue Method
IScalarData::setValue Method (IElement*)
IScalarData::setValue Method (char*)
IScalarData::setValue Method (double)
IScalarData::setValue Method (int)
IScalarDataView Class
ISession Class
ISession Members
ISession::clearBuffers Method
ISession::close Method
ISession::ISession Constructor
ISession::closeAllData Method
ISession::getConfig Method
ISession::openData Method
ISession::openMultiDim Method
ISession::openProcedure Method
ISession::openScalar Method
ISession::openSet Method
ISession::setCallBack Method
updateData Method
ISession::updateData Method (int)
ISession::updateData Method (std::vector<class IData*>&, int)
ISetData Class
ISetData Members
add Method
ISetData::add Method (IElement*)
ISetData::add Method (char*)
ISetData::add Method (int)
appendLabels Method
ISetData::appendLabels Method (char* const, int)
ISetData::appendLabels Method (int, int)
contains Method
ISetData::contains Method (IElement*)
ISetData::contains Method (char*)
ISetData::contains Method (int)
ISetData::createElement Method
ISetData::elementCompatible Method
ISetData::createIterator Method
remove Method
ISetData::remove Method (IElement*)
ISetData::remove Method (char*)
ISetData::remove Method (int)
setLabels Method
ISetData::setLabels Method (char* const, int)
ISetData::setLabels Method (int, int)
ISetIterator Class
ISetIterator Members
ISetIterator::close Method
ISetIterator::createElement Method
ISetIterator::element Method
ISetIterator::elementCompatible Method
ISetIterator::getElement Method
ISetIterator::next Method
ISetIterator::reset Method
ITuple Class
[] Operator
ITuple::[] Operator (int)
ITuple::[] Operator (int)
ITuple Members
ITuple::clone Method
ITuple::close Method
ITuple::copy Method
ITuple::getDimension Method
ITuple::isValid Method
ITuple::printLabels Method
ITuple::setTuple Method
aimms::<< Function
Tuple Class
Tuple Members
Tuple Constructor
Tuple::Tuple Constructor ()
Tuple::Tuple Constructor (TupleArg&)