7.8 JointManagementType ObjectType Definition
7.8.1 Overview
The JointManagementType provides access to the Joint and associated information and is formally defined in Table 132.
| Attribute | Value | ||||
| BrowseName | JointManagementType | ||||
| IsAbstract | False | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | Other |
|---|---|---|---|---|---|
| Subtype of the 0:BaseObjectType defined in OPC 10000-5, i.e., inheriting the InstanceDeclarations of that Node. | |||||
| 0:HasProperty | Variable | 0:DefaultInstanceBrowseName | 0:QualifiedName | 0:PropertyType | |
| 0:HasComponent | Method | SendJoint | O | ||
| 0:HasComponent | Method | SendJointDesign | O | ||
| 0:HasComponent | Method | SendJointComponent | O | ||
| 0:HasComponent | Method | SelectJoint | O | ||
| 0:HasComponent | Method | GetJointList | O | ||
| 0:HasComponent | Method | GetJointRevisionList | O | ||
| 0:HasComponent | Method | GetJointDesignList | O | ||
| 0:HasComponent | Method | GetJointComponentList | O | ||
| 0:HasComponent | Method | GetJoint | O | ||
| 0:HasComponent | Method | GetJointDesign | O | ||
| 0:HasComponent | Method | GetJointComponent | O | ||
| 0:HasComponent | Method | DeleteJoint | O | ||
| 0:HasComponent | Method | DeleteJointDesign | O | ||
| 0:HasComponent | Method | DeleteJointComponent | O | ||
| Conformance Units | |||||
|---|---|---|---|---|---|
| IJT Method Input Argument | |||||
| IJT Joint Management | |||||
| IJT Send Joint | |||||
| IJT Get Joint List | |||||
| IJT Select Joint | |||||
| IJT Joint Data | |||||
| IJT Get Joint | |||||
| IJT Send Joint Design | |||||
| IJT Get Joint Design List | |||||
| IJT Get Joint Design | |||||
| IJT Joint Design Data | |||||
| IJT Send Joint Component | |||||
| IJT Get Joint Component List | |||||
| IJT Get Joint Component | |||||
| IJT Joint Component Data | |||||
| IJT Joint Management | |||||
| IJT Delete Joint | |||||
| IJT Delete Joint Design | |||||
| IJT Delete Joint Component | |||||
| IJT Get Joint Revision List |
The component Variables of the JointManagementType have additional Attributes defined in Table 133.
| BrowsePath | Value Attribute | Description Attribute |
| 0:DefaultInstanceBrowseName | JointManagement | The default BrowseName for instances of the type. |
7.8.2 SendJoint
The Method SendJoint is used to send a joint to a joining system. If the input joint already exists in the system, it shall be overwritten.
The signature of this Method is specified below. Table 134 and Table 135 specify the Arguments and AddressSpace representation, respectively.
Signature
SendJoint (
[in] 0:String productInstanceUri,
[in] JointDataType joint,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| joint | With this argument the Client can provide the content of the joint. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | SendJoint | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.8.3 SendJointDesign
The Method SendJointDesign is used to send a joint design to a joining system. If the input joint design already exists in the system, it shall be overwritten.
The signature of this Method is specified below. Table 136 and Table 137 specify the Arguments and AddressSpace representation, respectively.
Signature
SendJointDesign (
[in] 0:String productInstanceUri,
[in] JointDesignDataType jointDesign,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| jointDesign | With this argument the Client can provide the content of the joint design. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | SendJointDesign | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.8.4 SendJointComponent
The Method SendJointComponent is used to send a joint component to a joining system. If the input joint component already exists in the system, it shall be overwritten.
Examples: Threaded fastener, rivet, etc.
The signature of this Method is specified below. Table 138 and Table 139 specify the Arguments and AddressSpace representation, respectively.
Signature
SendJointComponent (
[in] 0:String productInstanceUri,
[in] JointComponentDataType jointComponent,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| jointComponent | With this argument the Client can provide the joint component. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | SendJointComponent | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.8.5 SelectJoint
The Method SelectJoint is used to select the joint and the associated joining process.
The signature of this Method is specified below. Table 140 and Table 141 specify the Arguments and AddressSpace representation, respectively.
Signature
SelectJoint (
[in] 0:String productInstanceUri,
[in] 0:TrimmedString jointId,
[in] 0:TrimmedString jointOriginId,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| jointId | With this argument the Client can provide the identifier of the joint which should be selected for performing the next joining operation. |
| jointOriginId | With this argument the Client can provide the common identifier of the joint which should be selected for performing the next joining operation. It is optional and can be empty if the underlying system does not manage revisions of a joint. If jointId is provided, then this argument shall be ignored. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | SelectJoint | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.8.6 GetJointList
The Method GetJointList is used to get the list of available joints in the system.
The signature of this Method is specified below. Table 142 and Table 143 specify the Arguments and AddressSpace representation, respectively.
Signature
GetJointList (
[in] 0:String productInstanceUri,
[out] JointDataType[] jointList,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| jointList | It is the list of joints available in the system. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | GetJointList | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.8.7 GetJointRevisionList
The Method GetJointRevisionList is used to get the list available revisions of a specific joint based on the jointOriginId.
The signature of this Method is specified below. Table 144 and Table 145 specify the Arguments and AddressSpace representation, respectively.
Signature
GetJointRevisionList (
[in] 0:String productInstanceUri,
[in] 0:TrimmedString jointOriginId,
[out] JointDataType[] jointList,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| jointOriginId | It is the origin identifier of the joint which is used to manage the revisions of a given joint. |
| jointList | It is the list of joints available in the system. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | GetJointRevisionList | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.8.8 GetJointDesignList
The Method GetJointDesignList is used to get the list of available joint designs in the system.
The signature of this Method is specified below. Table 146 and
Table 147 specify the Arguments and AddressSpace representation, respectively.
Signature
GetJointDesignList (
[in] 0:String productInstanceUri,
[out] JointDesignDataType[] jointDesignList,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| jointDesignList | It is the list of joint designs available in the system. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | GetJointDesignList | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.8.9 GetJointComponentList
The Method GetJointComponentList is used to get the list of available joint components in the system.
The signature of this Method is specified below. Table 148 and Table 149 specify the Arguments and AddressSpace representation, respectively.
Signature
GetJointComponentList (
[in] 0:String productInstanceUri,
[out] JointComponentDataType[] jointComponentList,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| jointComponentList | It is the list of joint components available in the system. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | GetJointComponentList | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.8.10 GetJoint
The Method GetJoint is used to get the joint based on the input identifier.
The signature of this Method is specified below. Table 150 and Table 151 specify the Arguments and AddressSpace representation, respectively.
Signature
GetJoint (
[in] 0:String productInstanceUri,
[in] 0:TrimmedString jointId,
[out] JointDataType joint,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| jointId | It is the identifier of the joint. |
| joint | It is the joint based on the input identifier. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | GetJoint | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.8.11 GetJointDesign
The Method GetJointDesign is used to get the joint design based on the input identifier.
The signature of this Method is specified below. Table 152 and Table 153 specify the Arguments and AddressSpace representation, respectively.
Signature
GetJointDesign (
[in] 0:String productInstanceUri,
[in] 0:TrimmedString jointDesignId,
[out] JointDesignDataType jointDesign,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| jointDesignId | It is the identifier of the joint design |
| jointDesign | It is the joint design based on the input identifier. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | GetJointDesign | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.8.12 GetJointComponent
The Method GetJointComponent is used to get the joint component based on the input identifier.
The signature of this Method is specified below. Table 154 and Table 155 specify the Arguments and AddressSpace representation, respectively.
Signature
GetJointComponent (
[in] 0:String productInstanceUri,
[in] 0:TrimmedString jointComponentId,
[out] JointComponentDataType jointComponent,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| jointComponentId | It is the identifier of the joint component. |
| jointComponent | It is the joint component based on the input identifier. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | GetJointComponent | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.8.13 DeleteJoint
The Method DeleteJoint is used to delete the joint based on the input identifier.
The signature of this Method is specified below. Table 150 and Table 151 specify the Arguments and AddressSpace representation, respectively.
Signature
DeleteJoint (
[in] 0:String productInstanceUri,
[in] 0:TrimmedString jointId,
[in] 0:TrimmedString jointOriginId,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| jointId | It is the identifier of the joint. |
| jointOriginId | With this argument the Client can provide the common identifier of the joint which should be selected for performing the next joining operation. It is optional and can be empty if the underlying system does not manage revisions of a joint. If jointId is provided, then this argument shall be ignored. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | DeleteJoint | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.8.14 DeleteJointDesign
The Method DeleteJointDesign is used to delete the joint design based on the input identifier.
The signature of this Method is specified below. Table 150 and Table 151 specify the Arguments and AddressSpace representation, respectively.
Signature
DeleteJointDesign (
[in] 0:String productInstanceUri,
[in] 0:TrimmedString jointDesignId,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| jointDesignId | It is the identifier of the joint design. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | DeleteJointDesign | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.8.15 DeleteJointComponent
The Method DeleteJointComponent is used to delete the joint component based on the input identifier.
The signature of this Method is specified below. Table 150 and Table 151 specify the Arguments and AddressSpace representation, respectively.
Signature
DeleteJointComponent (
[in] 0:String productInstanceUri,
[in] 0:TrimmedString jointComponentId,
[out] 0:Int64 status,
[out] 0:LocalizedText statusMessage)| Argument | Description |
| productInstanceUri | With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
| jointComponentId | It is the identifier of the joint component. |
| status | It provides the status of the Method execution. Refer 7.4 for details. |
| statusMessage | It provides the high-level status information in a user-friendly text. |
| Attribute | Value | ||||
| BrowseName | DeleteJointComponent | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |