Sepasoft MES Module Suite
Sample Definition Signal Object
The Sample Definition Signal Object holds all of the information defining a signal that will be applied to a sample definition. Be sure not to confuse a signal defined in the Ignition designer with the sample definition signal object. The sample definition signal object connects a signal defined in the Ignition designer with a sample definition.
If a signal is associated with a sample definition, it will appear as an option in the SPC Selector and can appear on control charts. It will also be included during automatic signal evaluations.
Properties
getEnabled()
Description
Returns true if this sample definition signal is enabled. If disabled, it will not show as an option on the control charts.
Syntax
getEnabled()
- Parameters
None
- Returns
True, if this sample definition signal is enabled.
getId()
Depreciated
|
Depreciated in MES 3.0 Use getName() |
Description
Returns the database created ID for this sample definition signal.
Syntax
getId()
- Parameters
None
- Returns
int id - Integer value representing the id of this sample definition signal.
getKind()
Description
Returns the the kind of signal. There are different types of signals and calculations for each type of chart category and this property makes this association between the two.
Syntax
getKind()
- Parameters
None
- Returns
getName()
Description
Returns the name of this signal as defined in the Ignition designer.
Syntax
getName()
- Parameters
None
- Returns
String name
getParent()
Description
Returns the sample definition that this signal is a child of.
Syntax
getParent()
- Parameters
None
- Returns
isModified()
Description
Returns true if this sample definition signal has been modified.
Syntax
isModified()
- Parameters
None
- Returns
True, if this sample definition signal is modified.
isNew()
Description
Returns true if this sample definition signal is new.
Syntax
isNew()
- Parameters
None
- Returns
True, if this sample definition signal is new.
setEnabled(enabled)
Description
Sets this sample definition signal enabled state. If disabled, it will not show as an option on the control charts.
Syntax
setEnabled(enabled)
- Parameters
boolean enabled
- Returns
Nothing
setKind(kind)
Description
Sets the kind of signal. There are different types of signals and calculations for each type of chart category and this property makes this association between the two.
Syntax
setKind(kind)
- Parameters
SignalKindTypes kind
- Returns
Nothing
setKind(ordinal)
Description
Sets the kind of signal based on a SignalKindTypesordinal value. There are different types of signals and calculations for each type of chart category and this property makes this association between the two.
Syntax
setKind(ordinal)
- Parameters
int ordinal
- Returns
Nothing
setName(name)
Description
Sets the name of this signal as defined in the Ignition designer.
Syntax
setName(name)
- Parameters
String name
- Returns
Nothing
Sepasoft MES Module Suite