Response Equipment Property

Sepasoft MES Module Suite

Response Equipment Property | Response Object

When an operation is executed, this object is created that stores information about the equipment used in the operation. It is the related to the Equipment Resource Property object that defines the equipment that can be used by an operation. 

This object is not derived from the MESAbstractObject. Instead it derives from AbstractMESComplexProperty object and inherits all its functions and properties.

Object Creation

The following object methods return a Response Equipment Property object.

 

Copy Code
Python
obj = system.mes.loadMESObject('Mix Nuts','RequestSegment')
obj.getEquipmentProperty()

Copy Code
Python
{EquipmentRef=Response Line, Mixing Line 1, EquipmentRefUUID=e4b0d300-be1c-434b-973d-8c9f159646b2, EquipmentRefType=ResponseLine, EquipmentQuantity=0.0, EquipmentUnits=, EquipmentUse=, EquipmentRefPath=[global]\Nuts Unlimited\Folsom\Mixing\Mixing Line 1}


Object Functions

This object provides the following functions:

 

getEquipmentRef()

Description

 Get reference to the equipment.

Syntax

getEquipmentRef()

  • Parameters

 None

  • Returns

 MESObjectLink equipmentRef - Reference to the equipment.

  • Scope

All

 

getEquipmentRefPath()

Description

 Get the path to equipment reference.

Syntax

getEquipmentRefPath()

  • Parameters

 None

  • Returns

 String equipmentRefPath - Path to the equipment reference.

  • Scope

All

 getEquipmentRefProperty()

Description

 Get the equipment reference property.

Syntax

getEquipmentRefProperty()

  • Parameters

 None

  • Returns

 String equipmentRefProperty - The equipment reference property.

  • Scope

All

 getEquipmentRefType()

Description

 Get the type of equipment reference.

Syntax

getEquipmentRefType()

  • Parameters

 None

  • Returns

 String equipmentRefType - The type of equipment reference.

  • Scope

All

 

getEquipmentRefUUID()

Description

 Get the uuid that corresponds to equipment reference.

Syntax

getEquipmentRefUUID()

  • Parameters

 None

  • Returns

 String equipmentRefUUID - The unique identifier that corresponds to equipment reference.

  • Scope

All

 

getEquipmentVersionRefUUID()

Description

 Get the uuid that corresponds to equipment version reference.

Syntax

getEquipmentVersionRefUUID()

  • Parameters

 None

  • Returns

 String equipmentRefUUID - The unique identifier that corresponds to equipment version reference.

  • Scope

All

 getOptional()

Description

Returns the corresponding Boolean after checking whether the equipment property is optional or not.

Syntax

getOptional()

  • Parameters

 None

  • Returns

 boolean - True if this property is optional and False otherwise.

  • Scope

All

 

getQuantity()

Description

Get the quantity of equipment. This is here in compliance with ISA-95 standard.

Syntax

getQuantity()

  • Parameters

 None

  • Returns

 Double quantity - The quantity of equipment.

  • Scope

All

 

getUnits()

Description

Get units defined for this equipment.

Syntax

getUnits()

  • Parameters

 None

  • Returns

 String units - The units for equipment.

  • Scope

All

 

setEquipmentRef(equipmentRef)

Description

 Set reference to the equipment property.

Syntax

setEquipmentRef(equipmentRef)

  • Parameters

 MESObjectLink equipmentRef - Reference to the equipment property.

  • Returns

 Nothing

  • Scope

All

 

setEquipmentRefPath(equipmentRefPath)

Description

Set the path to equipment reference.

Syntax

setEquipmentRefPath(equipmentRefPath)

  • Parameters

String equipmentRefPath - Path to the equipment reference.

  • Returns

 Nothing

  • Scope

All

 

setEquipmentRefType(equipmentRefType)

Description

 Set the type of equipment reference.

Syntax

setEquipmentRefType(equipmentRefType)

  • Parameters

String equipmentRefType - The type of equipment reference.

  • Returns

Nothing

  • Scope

All

 

setEquipmentRefUUID(equipmentRefUUID)

Description

 Set the UUID that corresponds to equipment reference.

Syntax

setEquipmentRefUUID(equipmentRefUUID)

  • Parameters

 String equipmentRefUUID - The unique identifier that corresponds to equipment reference.

  • Returns

 Nothing

  • Scope

All

 setOptional(optional)

Description

Sets the equipment property to optional or not.

Syntax

setOptional(optional)

  • Parameters

boolean optional - True if this property is optional and False otherwise.

  • Returns

 Nothing

  • Scope

All

setQuantity(quantity)

Description

Set the quantity of equipment. This is here in compliance with ISA-95 standard.

Syntax

setQuantity(quantity)

  • Parameters

 Double quantity - The quantity of equipment.

  • Returns

 Nothing

  • Scope

All

 

setUnits(units)

Description

Set units defined for this equipment.

Syntax

setUnits(units)

  • Parameters

 String units - The units for equipment.

  • Returns

 Nothing

  • Scope

All

Sepasoft MES Module Suite