Initializing help system before first use

XPRMModel Properties

The XPRMModel type exposes the following members.

Properties
  Name Description
Public property AnnotatedIdentifiers
Array containing the annotations of the given identifier in this model
Public property Date
This is model compilation date
Public property ExecStatus
Get execution status. The execution status indicates whether the execution terminated normally.
Public property ExitCode
Result of the execution of the model. This method returns the result of the execution of a model (i.e. the parameter value of the exit procedure) with method Run
Public property Identifiers
All identifiers of the model (list of XPRMIdentifier objects)
Public property IsLoaded
Check if the model is loaded. A model will be loaded from when it is created until when UnLoad is called.
Public property IsRunning
Check whether the model is being executed.
Public property LastLineIndex
Maximum value to be used with GetLocation(Int32). This value is -1 when no debugging information is available for the model.
Public property Model
Used to fetch the XPRM model to which this object belongs, or else 'null' if there is no model anywhere among this Object's ancestors.
(Inherited from XPRMObjectBase.)
Public property Name
Name of the problem. This name is generated automatically when the model is loaded into memory.
Public property Number
Model number. An order number is assigned to the model when it is loaded into memory.
Public property ObjectiveValue
Objective value of the main problem, or 0 if no problem has been solved.
Public property Owner
Used to fetch the XPRM object to which this object belongs
(Inherited from XPRMObjectBase.)
Public property Parameters
List containing all parameters in the model (XPRMParameter objects)
Public property ProblemIsValid
Check whether the problem in the optimizer is valid. The problem may have been modified between the last optimisation and the end of the execution. In this case the solution returned may not be valid.
Public property ProblemStatus
Get main problem status after execution.
Public property Result Obsolete.
Result of the execution of the model. This method returns the result of the execution of a model (i.e. the parameter value of the exit procedure) with method Run
Public property Size
This is the amount of memory (in bytes) used by the model. Note that memory allocated by modules is not counted (for instance memory used by the optimizer is not reported by this property).
Public property SolutionAvailable
Check whether a solution is available.
Public property SysComment
System comment. The system comment is generated by the compiler.
Public property UserComment
User comment. The user comment is provided by the user at compile time (see Compile(String, String, String, String))
Public property Version
Get Model version.
Top
See Also

© 2001-2021 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.