Parse Value

Sepasoft MES Module Suite

Parse Value

A ParseValue object is available from the get method of the ParseResults object. Because parse values contain additional information such as units, data type, if it is required, etc, the value is contained in this object. Read the true value from the parse value uses getValue() function.

Properties


getName()

Description

Gets the name of the parse value.

Syntax

getName()

Parameters

 None

  • Returns

Name of this parse value. 

  • Scope

All


getType()

Gets the type of this parse value.

Syntax

getType()

Parameters

 None

Returns

The parse value type.

Scope

All


getUnits()

Gets the units extracted during parsing for this parse value. The Include Units option must be selected in the parse box options for the units to be extracted. 

Syntax

getUnits()

Parameters

 None

Returns

The units extracted during parsing for this parse value.

Scope

All


getValue()

Returns the true value of this parse value. For example, if the data type defined in the parse box options is a Float8, then a double will be returned.

Syntax

getValue()

Parameters

 None

Returns

The exact value of this parse value.

Scope

All


isRequired()

Checks to see if a parse value is required.

Syntax

isRequired()

Parameters

 None

Returns

If true indicates this parse value is required.

Scope

All


isRequiredValid()

Checks to see if a parse value is required and is valid.

Syntax

isRequiredValid()

Parameters

 None

Returns

If true indicates this parse value is required and is valid.

Scope

All


isValid()

Checks to see if a parse value is valid.

Syntax

isValid()

Parameters

 None

Returns

True, if parse value is valid.

Scope

All

Sepasoft MES Module Suite