Sepasoft MES Module Suite
Sample Definition Control Limit Object
The Sample Definition Control Limit Object holds all of the information defining a control limit that is applied to a Sample Definition.
|
Be sure not to confuse a control limit defined in the Ignition designer with the sample definition control limit object. The sample definition control limit object connects a control limit defined in the Ignition designer with a sample definition. |
Once a Control Limit is associated with a Sample definition, it appears as an option in the SPC Selector and can appear on Control Charts. It is also included during automatic signal evaluations that require the control limit.
Properties
getEnabled()
Description
Returns true if this sample definition control limit 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 control limit is enabled.
getGroup()
Description
Syntax
getGroup()
- Parameters
None
- Returns
String - the group name set for a control limit kind via the equipment manager.
getId()
Depreciated
|
Depreciated in MES 3.0 Use getName() |
Description
Returns the database created ID for this sample definition control limit.
Syntax
getId()
- Parameters
None
- Returns
Integer id - The identifier for this sample definition control limit.
getKind()
Description
Returns the kind of control limit. There are different types of control limits and calculations for each type of chart category and this property makes this association between the two.
Syntax
getKind()
- Parameters
None
- Returns
ControlLimitKindTypes kind - The type of this control limit.
getKindAsInt()
getName()
Description
Returns the name of this control limit as defined in the Ignition designer.
Syntax
getName()
- Parameters
None
- Returns
String name - The name of this control limit.
getParent()
Description
Returns the sample definition that this control limit is a child of.
Syntax
getParent()
- Parameters
None
- Returns
isModified()
Description
Returns true if this sample definition control limit has been modified.
Syntax
isModified()
- Parameters
None
- Returns
True if this sample definition control limit has been modified.
isNew()
Description
Returns true if this sample definition control limit is new.
Syntax
isNew()
- Parameters
None
- Returns
True, if this sample definition control limit is new.
resetModified()
Description
This script function will undo the modifications done.
Syntax
resetModified()
- Parameters
None
- Returns
Nothing
setEnabled(enabled)
Description
Sets this sample definition control limit enabled state. If disabled, it will not show as an option on the control charts.
Syntax
setEnabled(enabled)
- Parameters
boolean enabled
- Returns
Nothing
setGroup(group)
setKind(kind)
Description
Sets the kind of control limit. There are different types of control limits and calculations for each type of chart category and this property makes this association between the two.
Syntax
setKind(kind)
- Parameters
ControlLimitKindTypes kind - The type of this control limit.
- Returns
Nothing
setKind(ordinal)
Description
Set the kind of control limit based on a ControlLimitKindTypes ordinal value. There are different types of control limits 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 control limit as defined in the Ignition designer.
Syntax
setName(name)
- Parameters
String name - The name of this control limit.
- Returns
Nothing
setParent(parent)
Sepasoft MES Module Suite