Analysis Dataset

Analysis Dataset

Whenever the analysis settings are passed to the analysis engine for execution and provide Analysis Results, they are returned in the form of the Analysis Dataset object type.

This object is not derived from the MESAbstractObject and therefore does not inherit its functions or properties.

Object Creation

This object is created by the OEE Downtime Analysis Selector and Controller components, and when using the SPC C-Chart | Vision, Histogram Chart | Vision, Individual and Range Chart - Vision, Median and Range Chart - Vision, NP-Chart | Vision, Pareto Chart - Vision, P-Chart | Vision, Process Capability Chart | Vision, Process Performance Chart | Vision, U-Chart | Vision, Xbar and R Chart - Vision, and Xbar and S Chart components. 

The following scripting functions return this type of object:

• system.mes.analysis.executeAnalysis().getDataset(): Returns the MESAnalysisResults object and the getDataset() method.
• system.mes.getInventory()
• system.mes.getLotInfoByName()
• system.mes.getLotInfoByUUID()
• system.mes.getLotTraceByLotName()
• system.mes.getLotTraceByLotUUID()
• system.mes.getLotTraceBySublotName()
• system.mes.getLotTraceBySublotUUID()
• system.mes.getSublotInfoByName()
• system.mes.getSublotInfoByUUID()
• system.mes.getEquipmentStateHistory()

The following object methods return this type of object:

• AndersonDarlingObject.getData()
• ControlLimitCalculatedValueObject.getData()
• ControlLimitEventObject.getData()
• CPEventObject.getData()
• CPPPEventObject.getData()
• MiscCalcEventObject.getData()
• PartsPerMillionEventObject.getData()
• ProcessPerformanceEventObject.getData()
• SignalEventObject.getData()
• MESAnalysisResults Object.getDataset()
  

Use

The following object method uses this object.

• ControlLimitCalculatedValueObject.setData()

Object Functions

This object provides the following functions:

• addColumn(columnName, dataType)
• appendRow(row)
• appendRows(ds)
• clearUniqueColumns()
• convertColumnType()
• deleteColumn(columnName)
• deleteRow(rowIndex)
• findUniqueRowIndex(rowData)
• getColumnCount()
• getColumnIndex(columnName)
• getColumnName(index)
• getColumnNames()
• getColumnType(index)
• getColumnTypes()
• getPrimitiveValueAt(rowIndex, columnIndex)
• getRow()
• getRowCount()
• getUniqueColumnIndexes()
• getValueAt(rowIndex, columnIndex)
• getValueAt(rowIndex, columnName)
• hasData()
• insertColumn(index, columnName, dataType)
• insertRow(index, row)
• mergeDataset(ds)
• mergeDataset(ds)
• renameColumn(name, newName)
• reverseRowOrder()
• setUniqueColumns(uniqueColumns)
• setValueAt(rowIndex, columnIndex, value)
• setValueAt(rowIndex, columnName, value)
• updateRow(rowIndex, row)

addColumn(columnName, dataType)

• Parameters

String columnName - The name of column to be added.

Class dataType - The datatype for the corresponding column elements.

• Returns

The column with count = 1.

appendRow(row)

Description

Appends a row to the list.

Syntax

appendRow(row)

• Parameters

List<Object> row - The row to append for.

• Returns

The row with count = 1.

appendRows(ds)

Description

Appends a set of rows into the analysis dataset.

Syntax

appendRows(ds)

• Parameters

AnalysisDataset ds - The dataset to which the rows are appended for.

• Returns

Nothing

clearUniqueColumns()

Description

Removes all those columns which are set unique.

Syntax

clearUniqueColumns()

• Parameters

None

• Returns

None

convertColumnType()

Changes the current column type.

Syntax

convertColumnType()

• Parameters

int index - The index of the column to convert the type for.

Class newType - The new column type.

• Returns

Nothing

deleteColumn(columnName)

Description

Deletes the column specified by the column name parameter.

Syntax

deleteColumn(columnName)

• Parameters

String columnName - The column name of dataset to be deleted for.

• Returns

Nothing

deleteRow(rowIndex)

Deletes the row specified by the row index parameter.

Syntax

deleteRow(rowIndex)

• Parameters

int rowIndex - The index representing the row to be deleted.

• Returns

Nothing

findUniqueRowIndex(rowData)

Finds out the unique index of row.

Syntax

findUniqueRowIndex(rowData)

• Parameters

List<Object> rowData - The row data to find the unique index for.

• Returns

Integer index - The unique index of the row.

getColumnCount()

Gets the no of columns associated with this dataset.

Syntax

getColumnCount()

• Parameters

None

• Returns

int size - The number of columns associated with this dataset.

getColumnIndex(columnName)

Gets the index associated with the specified column name.

Syntax

getColumnIndex(columnName)

• Parameters

String columnName - The name of the column.

• Returns

int index - The index of the column specified by the column name.

getColumnName(index)

Gets the name of the column specified by the index parameter.

Syntax

getColumnName(index)

• Parameters

int index - The index to get the column for.

• Returns

String columnName - The name of the column.

getColumnNames()

Gets all the names of columns associated with this dataset.

Syntax

getColumnNames()

• Parameters

None

• Returns

List<String> columnNames - Names of the columns corresponding to this dataset.

getColumnType(index)

Gets the type of the column specified by the index.

Syntax

getColumnType(index)

• Parameters

int index - The index to get the column type for.

• Returns

Class type - The class that specified column belongs to.

getColumnTypes()

Gets all the column types associated with this dataset.

Syntax

getColumnTypes()

• Parameters

None

• Returns

List<Class> columnTypes - All column types for this dataset.

getPrimitiveValueAt(rowIndex, columnIndex)

Gets the primitive value associated with this dataset.

Syntax

getPrimitiveValueAt(rowIndex, columnIndex)

• Parameters

int rowIndex - The row index of the dataset to return the primitive value for.

int columnIndex - The column index of the dataset to return the primitive value for.

• Returns

double value - The primitive value of this dataset.

getRow()

Returns the row corresponding to the index specified.

Syntax

getRow(rowIndex)

• Parameters

int rowIndex - The index of the row to return for.

• Returns

List<Object> row - The row data specified by the index parameter.

getRowCount()

Gets the size of the dataset.

Syntax

getRowCount()

• Parameters

None

• Returns

int rowCount - The number of rows for this dataset.

getUniqueColumnIndexes()

Returns a list of unique column indexes.

Syntax

getUniqueColumnIndexes()

• Parameters

None

• Returns

List<String> uniqueColumnIndexes - A list of all unique column indexes associated with this dataset.

getValueAt(rowIndex, columnIndex)

Gets the data corresponding to the row and column indexes specified.

Syntax

getValueAt(rowIndex, columnIndex)

• Parameters

int rowIndex - The row index to return the value for.

int columnIndex - The column index to return the value for.

• Returns

Object value - The data or value specified by the row and column indices.

getValueAt(rowIndex, columnName)

Gets the data corresponding to the row index and column name specified.

Syntax

getValueAt(rowIndex, columnName)

• Parameters

int rowIndex - The row index to return the value for.

String columnName - The name of the column to return the value for.

• Returns

Object value - The data corresponding to the specified row index and column name.

hasData()

Boolean specifying if this dataset contains value or is empty.

Syntax

hasData()

• Parameters

None

• Returns

boolean - True if the dataset has data and False if empty.

insertColumn(index, columnName, dataType)

Inserts a column with the specified parameters.

Syntax

insertColumn(index, columnName, dataType)

• Parameters

int index - The index value to be inserted.

String columnName - The column name to be inserted.

Class dataType - The data type for the column to be inserted.

• Returns

Nothing

insertRow(index, row)

Inserts a row with the specified parameters.

Syntax

insertRow(index, row)

• Parameters

int index - The index value to specify the row.

List<Object> row - The row data to be inserted.

• Returns

Nothing

mergeDataset(ds)

Merges this dataset with another analysis dataset.

Syntax

mergeDataset(ds)

• Parameters

 AnalysisDataset ds - The analysis dataset to merge with.

• Returns

Nothing

mergeDataset(ds)

Merges this dataset with another dataset.

Syntax

mergeDataset(ds)

• Parameters

 Dataset ds - The dataset to merge with this analysis dataset.

• Returns

Nothing

renameColumn(name, newName)

Renames a particular column.

Syntax

renameColumn(name, newName)

• Parameters

String name - Name of the column to change the name for.

String newName - The new name for the column.

• Returns

None

reverseRowOrder()

Reverses the order of rows.

Syntax

reverseRowOrder()

• Parameters

None

• Returns

Nothing

setUniqueColumns(uniqueColumns)

Sets unique columns for this dataset.

Syntax

setUniqueColumns(uniqueColumns)

• Parameters

List<String> uniqueColumns - A list of unique columns to set for.

• Returns

None

setValueAt(rowIndex, columnIndex, value)

Sets the value of a data element associated with the specified name and indices. The value parameter must be one of the following types: String, Short, Integer, Float, Double, Byte or byte[]. 

Syntax

setValueAt(rowIndex, columnIndex, value)

• Parameters

int rowIndex - Occurrence index of the data element, starting from zero.

String columnName - The name of column to set value for.

Object value - The data element.

• Returns

Nothing

setValueAt(rowIndex, columnName, value)

Sets the value of a data element associated with the specified index, name and value. The value parameter must be one of the following types: String, Short, Integer, Float, Double, Byte or byte[]. 

Syntax

setValueAt(rowIndex, columnName, value)

• Parameters

int rowIndex - Occurrence index of the data element, starting from zero.

String columnName - The name of column to set value for.

Object value - The data element.

• Returns

Nothing

updateRow(rowIndex, row)

Updates the row specified by the parameters.

Syntax

updateRow(rowIndex, row)

• Parameters

Integer rowIndex - The index of the row to update for.

List<Object> row - The list of objects in row to be updated.

• Returns

Nothing