ScenarioExecutionStatus

insight.getView()
  .withFirstScenario()
  .withExecutionStatus()
  .notify(function (scenario) {
    // Retrieve the current ScenarioExecutionStatus from a Scenario.
    scenario.getExecutionStatus().getJobId();
  });

Method summary

Methods

getExecutionDuration ( ) → {number}

The amount of time this job has been executing.

Returns:

Type	Description
number	the amount of time this job has been executing

Example

var execTimeInMs = status.getExecutionDuration();

Back to Top

getExecutionMode ( ) → {ExecutionMode|undefined}

The execution mode the current scenario execution is running. Or undefined if no execution status.

• See:
• ExecutionMode

Returns:

Type	Description
ExecutionMode | undefined	the execution mode object or undefined if there is no execution status

Back to Top

getExecutionResourceGroup ( ) → {ExecutionResourceGroup|undefined}

The execution resource group the current scenario execution belongs to. Or undefined if no execution status.

• See:
• ExecutionMode

Returns:

Type	Description
ExecutionResourceGroup | undefined	the execution resource group object or undefined if there is no execution status

Back to Top

getGap ( ) → {number}

Returns the current relative gap for this job.

Returns:

Type	Description
number	the current relative gap for this job

Example

var gapNum = status.getGap();

Back to Top

getJobId ( ) → {string}

The identifier of the job associated with this execution status.

Returns:

Type	Description
string	the job identifier associated with this execution status

Example

var jobId = status.getJobId();

Back to Top

getNumberOfSolutions ( ) → {number}

Returns the current number of solutions for this job.

Returns:

Type	Description
number	the current number of solutions for this job

Example

var numSolutions = status.getNumberOfSolutions();

Back to Top

getObjective ( ) → {number}

Returns the current objective value for this job.

Returns:

Type	Description
number	the current objective value for this job

Example

var num = status.getObjective();

Back to Top

getScenarioId ( ) → {string}

The identifier of the scenario associated with this execution status.

Returns:

Type	Description
string	the scenario identifier associated with this execution status

Example

var scenId = status.getScenarioId();

Back to Top

getStatus ( ) → {insight.enums.ScenarioExecutionStatus}

Return the job state code.

Returns:

Type	Description
insight.enums.ScenarioExecutionStatus	the job state code

Example

if ( status.getStatus() === insight.enums.ScenarioExecutionStatus.EXECUTING ) {
     // do something if scenario is executing
}

Back to Top

isExecuting ( ) → {boolean}

Returns true if this job is executing.

Returns:

Type	Description
boolean	true if this job is executing, otherwise false

Example

if ( status.isExecuting() ) {
     // run if scenario is currently executing.
}

Back to Top

isQueued ( ) → {boolean}

Returns true if this job is queued for execution.

Returns:

Type	Description
boolean	true if this job is queued for execution, otherwise false

Example

if ( status.isQueued() ) {
     // run if scenario is currently queued for execution.
}

Back to Top