Equipment Object Functions

Sepasoft MES Module Suite

Equipment Object Functions | Tag Collectors

The following functions are associated with the Tag Collector Complex Property (expand the table below for a list of all Tag Collector names and the proper name to use for scripting):

Tag Collector Property Names for Scripting

The available Tag Collector Property names for use in scripting are:

Tag Name (in MES Equipment Manager)	Tag Collector Property Name (for scripting)
Active Recipe	Active Recipe
Cycle Count	Equipment Cycle Count
Infeed Count Scale	Equipment Infeed Count Scale
Infeed Units	Equipment Infeed Units
Mode	Equipment Mode
Note	Equipment Note
Operation UUID	Equipment Operation UUID
Outfeed Units	Equipment Outfeed Units
Package Count	Equipment Package Count
Product Code	Equipment Product Code
Rate Period	Equipment Rate Period
Reject Count Scale	Equipment Reject Count Scale
Reject Units	Equipment Reject Units
Shift	Equipment Shift
Standard Rate	Equipment Standard Rate
State	Equipment State
Work Order	Equipment Work Order
Recipe Enabled	Recipe Enabled
Recipe Scale	Recipe Scale

getTagPath()

Description

Gets the Tag Path assigned to this Tag Collector Complex Property.

Syntax

getTagPath()

Parameters

None

Returns

String tagPath - The Tag Path assigned to this Tag Collector Complex Property.

Scope

All

                
                            #Get Tag Path for Infeed Units on Test Cell
                          
                            cell_path = "New Enterprise\Site\Area\Test Line\Test Cell"
                          
                            cell_obj = system.mes.loadMESObjectByEquipmentPath(cell_path)
                          
                            cell_property = cell_obj.getComplexProperty('TagCollector', 'Equipment Infeed Units')
                          
                            print cell_property.getTagPath()

Output

[default]New Enterprise/Site/Area/Test Line/Test Cell/Units

hasTagPath()

Description

Returns True if there is a Tag Path assigned to this Tag Collector Complex Property.

Syntax

hasTagPath()

Parameters

None

Returns

boolean hasTagPath - True if there is a Tag Path assigned to this Tag Collector Complex Property.

Scope

All

                
                            #Check the existence of a Tag Path for Infeed Units on Test Cell
                          
                            cell_path = "New Enterprise\Site\Area\Test Line\Test Cell"
                          
                            cell_obj = system.mes.loadMESObjectByEquipmentPath(cell_path)
                          
                            cell_property = cell_obj.getComplexProperty('TagCollector', 'Equipment Infeed Units')
                          
                            print cell_property.hasTagPath()

Output

True

setTagPath(tagPath)

Description

Sets the Tag Path for this Tag Collector Complex Property.

Syntax

setTagPath(tagPath)

Parameters

String tagPath - The Tag Path to set for this Tag Collector Complex Property.

Returns

None

Scope

All

                
                            #Set Tag Path for Shift
                          
                            shiftTagPath = "[default]New Enterprise/Site/Area/Test Line/Test Cell/Shift"
                          
                            cell_path = "New Enterprise\Site\Area\Test Line\Test Cell"
                          
                            cell_obj = system.mes.loadMESObjectByEquipmentPath(cell_path)
                          
                            cell_property = cell_obj.getComplexProperty('TagCollector', 'Equipment Shift')
                          
                            cell_property.setTagPath(shiftTagPath)
                          
                            system.mes.saveMESObject(cell_obj)

Output

The Shift property as viewed in the Tag Collectors section of 'Test Cell' (in the MES Equipment Manager component):

This object inherits the AbstractMESComplexProperty functions.

Sepasoft MES Module Suite

Equipment Object Functions - Tag Collector