Initializing help system before first use

Mosel

 
Classes
  Class Description
Public class XPRM
Methods for initialisation as well as model compilation and loading of compiled models into Mosel.
Public class XPRMAnnotation
An annotation in Mosel
Public class XPRMAnnotations
Defines a collection of annotations
Public class XPRMArray
An array in Mosel.
Public class XPRMCompileException
A compilation failure. This exception is thrown when the compilation of a model does not succeed.
Public class XPRMConstant
A constant in Mosel.
Public class XPRMConstants
Class to define a collection of XPRMConstant objects
Public class XPRMDependencies
List for holding dependancies (modules+packages) of a model
Public class XPRMDependency
A module or package as a model dependency.
Public class XPRMDicoIdent
A dictionary identifier in Mosel.
Public class XPRMException
Exception thrown when an unexpected condition occurs within Mosel
Public class XPRMExternal
A value for an external/native type. The only operation available is the generation of a text representation of the external type.
Public class XPRMIdentifiers
Class to define a collection of XPRMIdentifier objects. Objects in an XPRMIdentifiers list may be read from a local copy or may be read dynamically from Mosel; the precise action is not defined.. An XPRMIdentifiers list includes an indexer property you can use to find a named object quickly.
Public class XPRMInitializeContext
Context passed into an XPRMInitializationFrom delegate.
Public class XPRMIODriver
An IO driver.
Public class XPRMIODrivers
Defines a collection of XPRMIODriver objects
Public class XPRMLicense
An OEM license.
Public class XPRMLicenseException
Exception thrown when one of the component of Mosel is used without the necessary license. Further details can be found in the Xpress Licensing documentation.
Public class XPRMLinCtr
A linear constraint in Mosel. The functions provided here can be used to retrieve solution information after the problem has been solved.
Public class XPRMList
A list in Mosel
Public class XPRMLocation
A location in a model source.
Public class XPRMMemBlock
A named memory block. Named memory blocks can be allocated from a Mosel program using the 'mem' IO driver with a name (e.g. 'mem:myblk'). After execution of the model they can be found using their name then be accessed from .NET through a byte array.
Public class XPRMModel
A model in Mosel. This class contains the methods for executing models with Mosel.
Public class XPRMModule
A Mosel Module.
Public class XPRMModules
Defines a collection of XPRMModule objects
Public class XPRMMPVar
A decision variable in Mosel. The functions provided here can be used to retrieve solution information after the problem has been solved.
Public class XPRMNamedObjectsList
Class to define a collection of XPRMNamed objects. Objects in an XPRMNamedObjectsList list may be read from a local copy or may be read dynamically from Mosel; the precise action is not defined.. An XPRMNamedObjectsList list includes an indexer property you can use to find a named object quickly.
Public class XPRMNativeType
A native type (published by a module).
Public class XPRMNativeTypes
Defines a collection of XPRMNativeType objects.
Public class XPRMNotFoundException
Exception thrown when Mosel can't find something it expected
Public class XPRMObjectBase
All of the other classes that are backed by Mosel must inherit the XPRMObjectBase class - this defines a reference to the XPRMObject that the object was spawned by. This is done to prevent the XPRM object from being garbage-collected, which could lead to a Mosel model being unloaded or Mosel itself being exited while we're still trying to access data.
Public class XPRMObjectsList
Generic base-class for lists of objects in Mosel. XPRMObjectsList are read-only and cannot be modified, but they can store any XPRMObject type. Objects in an XPRMObjectsList may be read from a local copy or may be read dynamically from Mosel; the precise action is not defined.. Implemented classes should implement GetData() to populate an ArrayList with their data.
Public class XPRMParameter
A module or model parameter.
Public class XPRMParameters
Class to define a collection of XPRMParameter objects
Public class XPRMProblem
A problem object in Mosel.
Public class XPRMProblemComponents
Defines a collection of components of a problem type
Public class XPRMProcedure
A procedure or function supplied by a module or implemented in a model.
Public class XPRMProcedures
Class to define a collection of XPRMProcedure objects
Public class XPRMRecord
Represents a record in a Mosel model
Public class XPRMRecordField
Represents one field within a record
Public class XPRMRecordFields
Representation of a set of record fields
Public class XPRMReference
A reference to a Mosel scalar variable.
Public class XPRMRequirements
List of requirements of a model.
Public class XPRMSet
A set in Mosel.
Public class XPRMType
A type in Mosel.
Public class XPRMTypedIdentifier
A typed identifier in Mosel.
Public class XPRMTypedObject
Base class representing a typed value within a Mosel model
Public class XPRMTypeException
Exception thrown when a Mosel object is not of the expected type
Public class XPRMUserType
Public class XPRMValue
A value (of any type) stored in Mosel. Depending on the type, one of the as* function is defined and gives access to the corresponding .NET object.
Public class XPRMVersion
Version number in its encoded form.
Interfaces
  Interface Description
Public interface XPRMDebugger
Interface used to implement a model debugger. To implement a debugger, you should implement this interface then set the Debugger member of the XPRMModel class, which will call your Debug function when breakpoints occur in the model.
Public interface XPRMIdentifier
An identifier in Mosel. An identifier is a text symbol associated to an object. This interface is usually used through one of its subclasses which characterises the actual object linked to the symbol.
Public interface XPRMNamed
Interface implemented by any class with a Name property
Public interface XPRMObject
Interface implemented by all of the XPRM classes that are backed by the Mosel library. Each XPRMObject is "owned" by another XPRMObject, with the XPRM object at the root of the tree owning itself; this helps to prevent models et al being prematurely unloaded by Mosel's garbage-collector when other XPRMObjects are still active that are backed by resources in Mosel.
Public interface XPRMTyped
Represents a typed value within a Mosel model
Delegates
  Delegate Description
Public delegate XPRMInitializationFrom
A routine to initialize Mosel objects from .NET. A delegate of this type can be used to initialize Mosel objects from an 'initializations from' block, for which the filename is "dotnet:objname", with 'objname' being the bound name of the object. The XPRMInitializationFrom delegate is then called once for each label to be initialized.
Public delegate XPRMInitializationTo
A routine to retrieve a Mosel object into .NET. A delegate of this type can be used to initialize Java objects from an 'initializations to' block, for which the filename is "dotnet:objname", with 'objname' being the bound name of the object. The XPRMInitializationTo delegate is then called once for each label to be initialized.
Public delegate XPRMIOCallbackInput
Delegate defining IO driver callbacks for output streams. The model parameter may be null if the stream is being used directly by Mosel (for example, for compilation). Also passed is a reference to an object you specified when the callback was created. You should return a byte array containing the data to write - this must not be larger than maxWrite bytes.
Public delegate XPRMIOCallbackOutput
Delegate defining IO driver callbacks for input streams. This function will be called repeatedly as data is output by Mosel.The model parameter may be null if the stream is being used directly by Mosel (for example, for compilation). Also passed is a reference to an object you specified when the callback was created.
Public delegate XPRMIOCallbackOutputText
Delegate defining IO driver callbacks for text input streams. This function will be called repeatedly, once for each line of the Mosel output. The model parameter may be null if the stream is being used directly by Mosel (for example, for compilation). Also passed is a reference to an object you specified when the callback was created.
Enumerations
  Enumeration Description
Public enumeration XPRMCompileErrorCode
Error codes returned during compilation
Public enumeration XPRMInitializeControl
Enumeration of control values that can be passed to the initialization-from block through the XPRMInitializeContext object.
Public enumeration XPRMProblemStatus
Enumeration representing different possible problem states
Public enumeration XPRMRunResult
Enumeration representing different reasons that can cause a model run to end
Public enumeration XPRMStreamType
Defines a stream type or file input/output operation
Public enumeration XPRMVarStruct
Different structure codes for values in Mosel
Public enumeration XPRMVarType
Defines type codes for values in Mosel
Public enumeration XPRMVersionType
Different types of version information XPRM can return
Covered Topics
Parent Topic Reference

© 2001-2020 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.