Sepasoft MES Module Suite
ParseResults Object
A ParseResult object is available from the call to getParseResults() on the Serial Controller component.
Object Functions
getAll()
Description
Returns a list of all ParseValue objects.
Syntax
getAll()
- Parameters
None
- Returns
A list of all ParseValue objects.
- Scope
All
getValue()
Description
Returns a ParseValue object for the parsed value specified by the name parameter. The name must match one of the names assigned to a parsing box defined in the parsing template.
Syntax
getValue(name)
- Parameters
Name
- Returns
The ParseValue object for the parsed value specified by the name parameter.
- Scope
All
getRowCollection()
Description
Returns a Parse Row Collection object for the name specified by the name parameter. The name must match one of the names assigned to a parsing box defined in the parsing template.
Syntax
getRowCollection(name)
- Parameters
Name
- Returns
A Parse Row Collection object for the name specified by the name parameter.
- Scope
All
createDataset()
Description
Returns a Dataset object for the parsed value specified by the name parameter. The name must match one of the names assigned to a parsing box defined in the parsing template. This supports converting a ParseRowCollection that is a result of either a CSV Column Parsing Box or a CSV Row Parsing Box into a Dataset. Dataset can be used to display the data in Table or other components in Ignition.
Syntax
createDataset(name)
- Parameters
Name
- Returns
A Dataset object for the parsed value specified by the name parameter.
- Scope
All
createValueMap()
Description
Returns a Map object containing name value pairs for all parsed values. The Map can be sent to the SPC module's Sample Entry component to automate populating sample measurement values from an instrument. The Map can also be accessed using scripting.
Syntax
createValueMap(valueName)
- Parameters
String valueName
- Returns
A Map object containing name value pairs for all parsed values.
- Scope
All
Properties
isValid()
Description
Returns true if all parse values exist and are valid.
Syntax
isValid()
- Parameters
None
- Returns
If true indicates that all parse values exist and are valid.
- Scope
All
isRequiredValid()
Description
Returns true if all required parse values exist and are valid.
Syntax
isRequiredValid()
- Parameters
None
- Returns
If true indicates that all required parse values exist and are valid.
- Scope
All
get(type)
Description
Returns a list ParseValue objects of type specified by the parseValueType parameter.
Syntax
get(type)
- Parameters
ParseValueType type - Type of the parse value. Details are given in the Info section shown below.
- Returns
A list ParseValue objects of type specified by the parseValueType parameter.
- Scope
All
Info
|
Available parseValueType options: 1. A single, discrete value. system.instrument.parse.types.SingleValue 2. A collections of ParseRow objects. system.instrument.parse.types.RowCollection |
Sepasoft MES Module Suite