The Main OptiMax Object

The OptiMax object is the main object in OptiMax 2000 Component Library and is normally the first object that is defined in each project that uses OptiMax. All other objects in the OptiMax object hierarchy, are reachable from the collections contained by the OptiMax object.

Collections contained by the OptiMax Object

Solvers

Returns the Solvers collection of available solvers. (Object Property)

Options

Returns the MplOptions collection of current MPL options settings. (Object Property)

Models

Returns the Models collection of defined models. (Object Property)

Objects contained by the OptiMax Object

StatusWindow

Returns a StatusWindow object that can be used to control how the Status Window is diplayed. (Object Property)

Properties for the OptiMax Object

BinDirectory

The bin directory of the MPL OptiMax installation (string property - read only)

CurrentSolver

The current default Solver object. (Object Property - Read/Write)

FullVersionStr

The full version string of MPL OptiMax (string property - read only)

HomeDirectory

The home directory of the MPL OptiMax installation (string property - read only)

ModelDirectory

The model directory of the MPL OptiMax installation (string property - read only)

PlatformStr

The current platform of MPL OptiMax (string property - read only)

Version

The current version of MPL OptiMax. (String Property - Read Only)

VersionNumber

The current version number of MPL OptiMax (integer property - read only)

VersionStr

The current version string of MPL OptiMax (string property - read only)

WorkingDirectory

The current working directory for MPL. (String Property - Read/Write)

Methods for the OptiMax Object

ReadProjectFile (Filename)

Reads in a project file (.mpj) containing options for both MPL and the solvers. (Method)

ReadInitFile (Filename)

Reads in an init file (.ini) containing the solver setup information. (Method)

ScanForSolves (Filename)

Scans the path for supported solvers and loads them into the Solvers collection. (Method)

ToString

Returns a string representing the OptiMax object. (Method)

WriteProjectFile (Filename)

Writes out a project file (.mpj) containing options for both MPL and the solvers. (Method)

WriteInitFile (Filename)

Writes out an init file (.ini) containing the solver setup information. (Method)

VisualBasic Example:

    Private Function ParseCuttingStockModel() As Integer

    Dim MPL As OptiMax

    Set MPL = New OptiMax

    MPL.WorkingDirectory = "c:\mplwin4"

    MPL.ReadProjectFile("c:\mplwin4\mplwin.mpj")
    MPL.ReadInitFile("c:\mplwin4\mplwin41.ini")

    End Function