Skip to end of metadata
Go to start of metadata

Description

The MES Custom Property object holds information defined by the user, extending the custom property concept from core Ignition.  Custom Properties can be added to MES Objects via the MES Object Editor component or through scripting.  The purpose of this object is to attach additional relevant data points to any object in the system.

Note that unlike custom properties in core Ignition, the 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 Visibleread, writeThis 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:

Description

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

Description

Get the description of the custom property.

Syntax

getDescription()


  • Parameters

None

  • Returns

String name - The description of custom property.

  • Scope

All

Description

Get the name of the custom property.

Syntax

getName()


  • Parameters

None

  • Returns

String name - The name of custom property.

  • Scope

All

Description

Get the previous name of the custom property.

Syntax

getOldName()


  • Parameters

None

  • Returns

String oldName - The previous name of custom property.

  • Scope

All

Description

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

Description

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

Description

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

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

Description

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

Description

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

Description

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

  • No labels