MESAnalysisResults

Sepasoft MES Module Suite

MESAnalysisResults Object

The MESAnalysisResults object contains a dataset that is returned by the analysis engine based on the Analysis Settings (which may or may not be saved as an MESAnalysisSettings object) that were executed.  The object contains more than the bare result set, such as Drill Down data as well as other meta-data surrounding the analysis such as warnings and execution time. 

Inherits properites, methods and events from:

Object Creation

The following scripting function returns a MES Analysis Results object:

system.mes.analysis.executeAnalysis 

Object Functions

These are specific to this object:


addMessage(message)

Description

Adds a message to the analysis results.

Syntax

addMessage(message)

  • Parameters

 String  message - The message to be added.

  • Returns

 Nothing

  • Scope

All

 

getDataset()

Description

Gets dataset for the analysis results.

Syntax

getDataset()

  • Parameters

 None

  • Returns

AnalysisDataset dataset - The dataset with analysis results.

  • Scope

All

 

getDrillDownOptions()

Description

Gets the drill down options for the analysis results.

Syntax

getDrillDownOptions()

  • Parameters

 None

  • Returns

List<AbstractValueItemInfo> options - The drill down options for the analysis results.

  • Scope

All

 

getExecutionDurationMS()

Description

Gets the duration of execution in milliseconds.

Syntax

getExecutionDurationMS()

  • Parameters

 None

  • Returns

Long executionDurationMS - The duration of execution in milliseconds.

  • Scope

All

 

getMessage()

Description

Gets any messages set during execution

Syntax

getMessage()

  • Parameters

None

  • Returns

String - Message from Analysis

Example: The value for the (Equipment Path) filter item cannot be blank. 

  • Scope

All

 

hasMessage()

Description

Returns a Boolean informing if a message has been set in the results

Syntax

hasMessage()

  • Parameters

None

  • Returns

Boolean - True if a message is returned from analysis

  • Scope

All

 

setDrillDownOptions(List<AbstractValueItemInfo> drillDownOptionMap)

Description

Sets a list of drill down options for this analysis results.

Syntax

setDrillDownOptions(List<AbstractValueItemInfo> drillDownOptionMap)

  • Parameters

List<AbstractValueItemInfo> options - Drill down options for the analysis results.

  • Returns

 Nothing

  • Scope

All



Sepasoft MES Module Suite