8.6 MachineModuleSpecificationType ObjectType
8.6.1 Overview
The MachineModuleSpecificationType provides the specification of the machine module as currently operating including capabilities, internal buffers and loading points.
This MachineModuleSpecificationType is formally defined in the table below.
| Attribute | Value | ||||
| BrowseName | MachineModuleSpecificationType | ||||
| IsAbstract | False | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | Other |
|---|---|---|---|---|---|
| Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node. | |||||
| 0:HasComponent | Method | DeleteSpecificationRecord | See below. | M | |
| 0:HasComponent | Object | Documentation | 0:FolderType | M | |
| 0:HasComponent | Method | LoadMachineModuleDocumentation | See below. | M | |
| 0:HasProperty | Variable | LocationName | 0:String | 0:PropertyType | M, RW |
| 0:HasProperty | Variable | MaterialLoadingPoints | MaterialPointType[] | 0:PropertyType | M, RO |
| 0:HasProperty | Variable | MaterialOutputPoints | MaterialPointType[] | 0:PropertyType | M, RO |
| 0:HasProperty | Variable | MaterialRejectionPoints | MaterialPointType[] | 0:PropertyType | M, RO |
| 0:HasProperty | Variable | MaterialStorageBuffers | MaterialStorageBufferDataType[] | 0:PropertyType | M, RO |
| 0:HasComponent | Method | RemoveMachineModuleDocumentation | See below. | M | |
| 0:HasComponent | Method | SetNewSpecification | See below. | M | |
| 0:HasProperty | Variable | TimeZone | 0:TimeZoneDataType | 0:PropertyType | M, RW |
| 0:HasProperty | Variable | TotalRunningHours | 0:UInt64 | 0: PropertyType | M, RO |
| 0:HasProperty | Variable | UserMachineName | 0:String | 0:PropertyType | M, RW |
| 0:HasProperty | Variable | ValidSince | 0:UtcTime | 0:PropertyType | M, RO |
| 0:GeneratesEvent | ObjectType | MachineModuleSpecificationChangeLogType | |||
| Conformance Units | |||||
|---|---|---|---|---|---|
| TMC Single PO Production | |||||
| TMC Asset Management |
| BrowseName | Description |
| Documentation | The Object Documentation is the sole repository for the machine module documentation resources. The Documentation is accessed, for example, by clients and HMIs. |
| LocationName | The Property LocationName of type String contains the location of the machine module within the user production site. The Property LocationName will contain the following: Country/City/Department/Floor/Bay/Position. LocationName and UserMachineName uniquely identify the machine module in the user organization. |
| MaterialLoadingPoints | The Property MaterialLoadingPoints identifies the loading points of the machine module and their capability in terms of what materials can be loaded at a loading point. The Property MaterialLoadingPoints is defined as a list of objects of type MaterialPointType. |
| MaterialOutputPoints | The Property MaterialOutputPoints identifies the output points of the machine module and their capability in terms of what materials can be output The Property MaterialOutputPoints is defined as a list of objects of type MaterialPointType. |
| MaterialRejectionPoints | The Property MaterialRejectionPoints identifies the rejection points of the machine module and their capability in terms of what materials are rejected The Property MaterialRejectionPoints is defined as a list of objects of type MaterialPointType. |
| MaterialStorageBuffers | The Property MaterialStorageBuffers describes the buffers inside the machine module and their current status. The Property MaterialStorageBuffers is a list of objects of type MaterialStorageBufferDataType. |
| TimeZone | The local time zone where the machine operates. It is required to convert UTC times into local time. |
| TotalRunningHours | The Property TotalRunningHours counts the number of hours the machine module has been in operation since the last time its configuration was changed. More specifically, time is counted when the machine module state is different from: Stopping, Stopped, Aborting, Aborted, Clearing. |
| UserMachineName | The Property UserMachineName of type String contains the name used by the user to identify the machine module. LocationName and UserMachineName uniquely identify the machine module in the user organization. |
| ValidSince | The Property ValidSince is the date since the configuration was last modified. |
The components of the MachineModuleSpecificationType have additional subcomponents which are defined in the table below.
| BrowsePath | References | NodeClass | BrowseName | DataType | TypeDefinition | Others |
| Documentation | 0:HasProperty | Variable | <DocumentName> | 0:ByteString | 0:PropertyType | OP, RO |
8.6.2 DeleteSpecificationRecord Method
The DeleteSpecificationRecord Method deletes a specification record.
The signature of this Method is specified below. Table 40 specifies the Arguments representation.
Signature
DeleteSpecificationRecord (
[in] 0:NodeId SpecificationRecord,
[out] MethodExecutionFeedbackType ExecutionFeedback);| Argument | Description |
| SpecificationRecord | The OPC UA unique node identifier for the specification to be deleted from the underlying system repository. |
| ExecutionFeedback | The extended feedback returning a detailed message in case of execution failure. |
8.6.3 LoadMachineModuleDocumentation Method
The LoadMachineModuleDocumentation Method allows to securely load any machine module documentation to the documentation repository Documentation folder where it can be reached by applications.
The signature of this Method is specified below. Table 41 specifies the Arguments representation.
Signature
LoadMachineModuleDocumentation (
[in] 0:ByteString DocumentToBeLoaded,
[in] 0:String DocumentName,
[out] MethodExecutionFeedbackType ExecutionFeedback);| Argument | Description |
| DocumentToBeLoaded | The document, as a byte string, to be transferred to the Documentation folder. |
| DocumentName | The document name to be associated to the document in the underlying system. |
| ExecutionFeedback | The extended feedback returning a detailed message in case of execution failure. |
8.6.4 RemoveMachineModuleDocumentation Method
The RemoveMachineModuleDocumentation Method allows to securely remove, i.e. permanently delete, any machine module documentation from the documentation repository Documentation.
The signature of this Method is specified below. Table 42 specifies the Arguments representation.
Signature
RemoveMachineModuleDocumentation (
[in] 0:String DocumentName,
[out] MethodExecutionFeedbackType ExecutionFeedback);| Argument | Description |
| DocumentName | The document name to be associated to the document in the underlying system. |
| ExecutionFeedback | The extended feedback returning a detailed message in case of execution failure. |
8.6.5 SetNewSpecification Method
The Method SetNewSpecification saves its arguments as the new specification for the machine module. Prior to that it saves the previous specification into the PastSpecification Records Object of the same machine module.
The signature of this Method is specified below. Table 43 specifies the Arguments representation.
Signature
SetNewSpecification (
[in] MaterialPointType[] NewMaterialLoadingPoints,
[in] MaterialStorageBufferDataType[] NewMaterialStorageBuffers,
[in] MaterialPointType[] NewMaterialOutputPoints,
[in] MaterialPointType[] NewMaterialRejectionPoints,
[out] MethodExecutionFeedbackType ExecutionFeedback);| Argument | Description |
| NewMaterialLoadingPoints | The information about the material loading points that will be valid after the machine specification is changed. |
| NewMaterialStorageBuffers | The information about the storage buffers that will be valid after the machine specification is changed. |
| NewMaterialOutputPoints | The information about the material output points that will be valid after the machine specification is changed. |
| NewMaterialRejectionPoints | The information about the material rejection points that will be valid after the machine specification is changed. |
| ExecutionFeedback | The extended feedback returning a detailed message in case of execution failure. |