ScenarioSummaryData

Method summary

Methods

method

getExecutionTime ( ) → {number}

The time taken to last execute or load this scenario.

details

Returns:

returns table

Type	Description
type number	The time taken to last execute or load this scenario, or undefined if the scenario has not been loaded or executed

Back to Top

method

getGap ( ) → {number}

The Gap value for this scenario.

details

Returns:

returns table

Type	Description
type number	The Gap value for this scenario, or undefined if the scenario has no results data

Back to Top

method

getLastExecutionDate ( ) → {Date|undefined}

The date this scenario was last loaded or executed.

details

Returns:

returns table

Type	Description
type Date | undefined	The date this scenario was last loaded or executed, or undefined if it has not been loaded or executed

Back to Top

method

getModelStatus ( ) → {insight.enums.ModelStatus}

The status of the Insight model.

details

Returns:

returns table

Type	Description
type insight.enums.ModelStatus	The status of the Insight model

Back to Top

method

getNumberOfSolutions ( ) → {number}

The number of solutions found while executing this scenario.

details

Returns:

returns table

Type	Description
type number	The number of solutions found while executing this scenario, or undefined if the scenario has no results data

Back to Top

method

getObjective ( ) → {number}

The Objective value for this scenario.

details

Returns:

returns table

Type	Description
type number	The Objective value for this scenario, or undefined if the scenario has no results data

Back to Top

method

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.

details

Returns:

returns table

Type	Description
type insight.enums.ProblemStatus	The Problem Status of this scenario, or undefined if the scenario has no results data

Back to Top

method

hasResultData ( ) → {boolean}

Indicates whether this scenario has result data.

details

Returns:

returns table

Type	Description
type boolean	True if this scenario has result data, otherwise false

Back to Top

method

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.

details

Returns:

returns table

Type	Description
type boolean	True if the result data is dirty, otherwise false

Back to Top

method

isLoaded ( ) → {boolean}

Indicates whether this scenario is loaded with input data.

details

Returns:

returns table

Type	Description
type boolean	True if this scenario is loaded with input data, otherwise false

Back to Top