ScenarioSummaryData
Method summary
| name | description |
|---|---|
| getExecutionTime | The time taken to last execute or load this scenario. |
| getGap | The Gap value for this scenario. |
| getLastExecutionDate | The date this scenario was last loaded or executed. |
| getModelStatus | The status of the Insight model. |
| getNumberOfSolutions | The number of solutions found while executing this scenario. |
| getObjective | The Objective value for this scenario. |
| getProblemStatus | The Problem Status of this scenario. |
| hasResultData | Indicates whether this scenario has result data. |
| isDirty | Indicates whether the result data is dirty. |
| isLoaded | Indicates whether this scenario is loaded with input data. |
Methods
- getExecutionTime ( ) → {number}
-
The time taken to last execute or load this scenario.
detailsReturns:returns table
Back to TopType Description typenumberThe time taken to last execute or load this scenario, or undefined if the scenario has not been loaded or executed - getGap ( ) → {number}
-
The Gap value for this scenario.
detailsReturns:returns table
Back to TopType Description typenumberThe Gap value for this scenario, or undefined if the scenario has no results data - getLastExecutionDate ( ) → {Date|undefined}
-
The date this scenario was last loaded or executed.
detailsReturns:returns table
Back to TopType Description typeDate | undefinedThe date this scenario was last loaded or executed, or undefined if it has not been loaded or executed - getModelStatus ( ) → {insight.enums.ModelStatus}
-
The status of the Insight model.
detailsReturns:returns table
Back to TopType Description typeinsight.enums.ModelStatusThe status of the Insight model - getNumberOfSolutions ( ) → {number}
-
The number of solutions found while executing this scenario.
detailsReturns:returns table
Back to TopType Description typenumberThe number of solutions found while executing this scenario, or undefined if the scenario has no results data - getObjective ( ) → {number}
-
The Objective value for this scenario.
detailsReturns:returns table
Back to TopType Description typenumberThe Objective value for this scenario, or undefined if the scenario has no results data - getProblemStatus ( ) → {insight.enums.ProblemStatus}
-
The Problem Status of this scenario.
N.B. This returns the enumerated value for problem status (e.g. OPT). This should be translated to a human readable form.detailsReturns:returns table
Back to TopType Description typeinsight.enums.ProblemStatusThe Problem Status of this scenario, or undefined if the scenario has no results data - hasResultData ( ) → {boolean}
-
Indicates whether this scenario has result data.
detailsReturns:returns table
Back to TopType Description typebooleanTrue if this scenario has result data, otherwise false - isDirty ( ) → {boolean}
-
Indicates whether the result data is dirty, i.e. the input data has been modified since the scenario was last executed and the scenario is configured not to remove the result data when the input data is modified.
detailsReturns:returns table
Back to TopType Description typebooleanTrue if the result data is dirty, otherwise false - isLoaded ( ) → {boolean}
-
Indicates whether this scenario is loaded with input data.
detailsReturns:returns table
Back to TopType Description typebooleanTrue if this scenario is loaded with input data, otherwise false
© 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.