Abstract MES Property

Sepasoft MES Module Suite

Abstract MES Property

This object holds information about the path, UUID and children of an MES property. 

Success This object is not derived from the AbstractMESObject and therefore does not inherit its functions or properties.

Object Creation

The following object methods can be used to return this type of object.

Use

The following object methods use this object as a parameter.

Object Functions

Abstract MES Property object provides the following functions:

 

getChildProperties()

Description

Returns all the children properties as a property collection.

Syntax

getChildProperties()

  • Parameters

None

  • Returns

MESPropertyCollection childProperties - The collection of children properties.

  • Scope

All

Code Examples
Code Snippet
Copy Code
Python
mesObject = system.mes.loadMESObject('Mix Nuts', 'ProcessSegment')
equipRef = mesObject.getComplexProperty('Personnel', 'Sarah')
print equipRef.getChildProperties()

Output
Copy Code
Python
>>>
{PersonnelOptional=false, PersonnelProductionSelectable=true, PersonnelRef=Personnel Class, Mix Operators, PersonnelRefUUID=c1e017c5-4813-49e2-8725-8c044ec02857, PersonnelRefType=PersonnelClass, PersonnelUse=, PersonnelQuanity=0.0, PersonnelUnits=}
>>> >>>

 getPropertyPath()

Description

Gets path of the property.

Syntax

getPropertyPath()

  • Parameters

None

  • Returns

String propertyPath - Path of the property.

  • Scope

All

Code Examples
Code Snippet
Copy Code
Python
mesObject = system.mes.loadMESObject('Mix Nuts', 'ProcessSegment')
equipRef = mesObject.getComplexProperty('Personnel', 'Sarah')
print equipRef.getPropertyPath()

Output
Copy Code
Python
>>>
Personnel.Sarah
>>>

 getPropertyUUID()

Description

Gets the unique identifier representing the property.

Syntax

getPropertyUUID()

  • Parameters

None

  • Returns

String propertyUUID - The unique identifier representing the property.

  • Scope

All

Code Examples
Complex Property
Copy Code
Python
mesObject = system.mes.loadMESObject('Mix Nuts', 'ProcessSegment')
equipRef = mesObject.getComplexProperty('Personnel', 'Sarah')
print equipRef.getPropertyUUID()

Output
Copy Code
Python
>>>
36168128-fbe3-4d5b-8a56-017ef550e068
>>>

Custom Property
Copy Code
Python
equip = system.mes.loadMESObject('Test Equip', 'Equipment')
print equip
props = equip.getAllCustomProperties()
print props
for entry in props:
    print entry
    print type(entry)
    print entry.getPropertyUUID()

Output
Copy Code
Python
>>>
Equipment (568f9d0e-f72e-4611-9c67-97e3e18dd90b, Test Equip, 0 parents, 0 children, 1 custom properties, 0 complex properties)
[Test Property=12]
Test Property=12
<type 'com.sepasoft.production.common.model.mesobject.core.MESCustomProperty'>
7eeda65b-6447-49bd-a9e5-219cf35b9ac4
>>>

 

hasChildProperties()

Description

Checks whether the property has child property or not and return the corresponding boolean.

Syntax

hasChildProperties()

  • Parameters

None

  • Returns

boolean - True if the property has child property and False otherwise.

  • Scope

All

Code Examples
Code Snippet
Copy Code
Python
mesObject = system.mes.loadMESObject('Mix Nuts', 'ProcessSegment')
equipRef = mesObject.getComplexProperty('Personnel', 'Sarah')
print equipRef.hasChildProperties()

Output
Copy Code
Python
>>>
True
>>>

 logRenameChangeEvent(String oldName, String changeNote)

Description

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


Sepasoft MES Module Suite