Sepasoft MES Module Suite
User-Defined Properties on MES Objects
The MES Custom Property Object holds information that you can define as the developer of the system to extend the custom property concept from core Ignition. Doing this allows you to attach additional relevant data points to any object in the system.
Custom Properties can be added to MES Objects via the MES Object Editor component or through scripting.
|
MES Custom Property allows for complex data structures wherein child data points can be nested under parents to n levels. |
This object is derived from the Abstract MES Property and inherits its functions or properties.
Object Creation
The following object methods can be used to return this type of object.
Use
No scripting function or component use this object directly.
Object Properties
The following object properties can be used with this type of object:
Name | Type | Description |
|---|---|---|
| Production Visible | read, write | This is a boolean flag indicating if the Custom Property is visible during production or not. In the MES Operation Info panel, custom properties that are production visible may be seen by the user. |
| Required | read, write | This is a boolean flag indicating if the Custom Property value is required (True) or optional (False). |
Object Functions
This object provides the following functions:
getAllCustomProperties()
Returns all the custom properties for the MES Object upon which it is called as a list of MESCustomProperty objects. May also include inherited properties from parents.
Syntax
getAllCustomProperties()
- Parameters
None
- Returns
List<MESCustomProperty> - The list of custom properties.
- Scope
All
getDescription
Get the description of the custom property.
Syntax
getDescription()
- Parameters
None
- Returns
String name - The description of custom property.
- Scope
All
getAllCustomProperties()
Returns all the custom properties for the MES Object upon which it is called as a list of MESCustomProperty objects. May also include inherited properties from parents.
Syntax
getAllCustomProperties()
- Parameters
None
- Returns
List<MESCustomProperty> - The list of custom properties.
- Scope
All
getName()
Get the name of the custom property.
Syntax
getName()
- Parameters
None
- Returns
String name - The name of custom property.
- Scope
All
getOldName()
Get the previous name of the custom property.
Syntax
getOldName()
- Parameters
None
- Returns
String oldName - The previous name of custom property.
- Scope
All
getUnits()
Get the unit of measure for the custom property.
Syntax
getUnits()
- Parameters
None
- Returns
String units - The value of units of the custom property.
- Scope
All
isEnabled()
Checks whether the custom property is enabled or not and returns the corresponding boolean value.
Syntax
isEnabled()
- Parameters
None
- Returns
boolean - True if the custom property is enabled and False if it is disabled.
- Scope
All
isInherited()
Checks whether the custom property is inherited from another custom property and returns the corresponding boolean value.
Syntax
isInherited()
- Parameters
None
- Returns
boolean - True if the custom property is inherited from another custom property and False if it is not inherited.
- Scope
All
logRenameChangeEvent(String oldName, String changeNote)
The 'changeNote' allows you to attach any arbitrary message to the change so that it appears in the Change Log table.
Syntax
logRenameChangeEvent(String oldName, String changeNote)
- Parameters
String oldName
String changeNote
- Scope
All
setDescription(description)
Set the description for the custom property.
Syntax
setDescription(description)
- Parameters
String name - The description to set for custom property.
- Returns
Nothing
- Scope
All
setEnable(enabled)
Sets the corresponding boolean value for the enabled property. If disabled then all the children properties are also disabled.
Syntax
setEnable(enabled)
- Parameters
None
- Returns
boolean - True if the custom property is enabled and False if it is disabled.
- Scope
All
setName(name)
Set the name for the custom property.
Syntax
setName(name)
- Parameters
String name - The name to set for the custom property.
- Returns
Nothing
- Scope
All
setName(String name, String changeNote)
Attaches any arbitrary message to the change so that it appears in the Change Log table.
Syntax
setName(String name, String changeNote)
- Parameters
String String name - The 'changeNote' allows you to attach any arbitrary message to the change so that it appears in the Change Log table.
- Returns
nothing
- Scope
All
setUnits(units)
Set the unit of measure of the custom property.
Syntax
setUnits(units)
- Parameters
String units - The value of units to be set for the custom property.
- Returns
Nothing
- Scope
All
Sepasoft MES Module Suite