This structure DataType holds the information for an AggregatedHealthType Variable (see 9.1).
The AggregatedHealthDataType is formally defined in Table 113.
Table 113 – AggregatedHealthDataType structure
|
Name |
Type |
Description |
|
AggregatedHealthDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
AggregatedDeviceHealth |
3:DeviceHealthOptionSet |
Aggregation of the DeviceHealth of the AutomationComponent’s top-level Assets |
|
AggregatedOperationalHealth |
3:OperationalHealthOptionSet |
Aggregation of the OperationalHealth of the AutomationComponent’s top-level FunctionalEntities |
The AggregatedHealthDataType representation in the AddressSpace is formally defined in Table 114.
Table 114 – AggregatedHealthDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
3:AggregatedHealthDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
The ApplicationId is used to store an identifier, which can be a Numeric, String, Guid, or ByteString.
The ApplicationId DataType is formally defined in Table 115.
Table 115 – ApplicationId union
|
Name |
Type |
Description |
|
ApplicationId |
Union |
Subtype of Union defined in OPC 10000-5 |
|
IdNumeric |
0:UInt32 |
|
|
IdString |
0:String |
A string identifier limited to a max of 4096 characters |
|
IdGuid |
0:Guid |
A GUID identifier. |
|
IdByteString |
0:ByteString |
A ByteString identifier limited to a max of 4096 bytes |
The ApplicationId representation in the AddressSpace is formally defined in Table 116.
Table 116 – ApplicationId definition
|
Attribute |
Value |
|||||
|
BrowseName |
3:ApplicationId |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Union defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX FunctionalEntity Base |
||||||
The ApplicationIdentifierDataType is used to represent identification parameters. The ApplicationIdentifierDataType is formally defined in Table 117.
Table 117 – ApplicationIdentifierDataType structure
|
Name |
Type |
Description |
|
ApplicationIdentifierDataType |
Structure |
Subtype of the Structure defined in OPC 10000-5 |
|
Name |
0:LocalizedText |
This is a human-readable name of the identifier |
|
UniqueIdentifier |
3:ApplicationId |
This is a unique identifier that can be compared programmatically. |
The ApplicationIdentifierDataType representation in the AddressSpace is formally defined in Table 118.
Table 118 – ApplicationIdentifierDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
3:ApplicationIdentifierDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX FunctionalEntity Base |
||||||
This enumeration represents the mode for Asset verification.
The enumeration is formally defined in Table 119.
Table 119 – AssetVerificationModeEnum items
|
Name |
Value |
Description |
|
AssetCompatibility |
0 |
Verify whether an Asset’s functionality matches or is compatible with the expectation of system engineering. |
|
AssetIdentity |
1 |
Verify whether an Asset’s identity meets the expectations of system engineering. |
|
AssetIdentityAndCompatibility |
2 |
Verify whether an Asset’s identity meets the expectation of system engineering and whether its functionality matches or is compatible with the expectation of system engineering. |
The AssetVerificationModeEnum representation in the AddressSpace is formally defined in Table 120.
Table 120 – AssetVerificationModeEnum definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:AssetVerificationModeEnum |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Enumeration defined in OPC 10000-5 |
||||||
|
0:HasProperty |
Variable |
0:EnumValues |
0:EnumValueType[] |
0:PropertyType |
|
|
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX ConnectionManager Base |
||||||
This structured DataType contains information required for Asset verification to be used as arguments in a Method Call (e.g., EstablishConnections).
It is semantically equivalent to the AssetVerificationType as defined in 6.15.2.
The structure is formally defined in Table 121.
Table 121 – AssetVerificationDataType structure
|
Name |
Type |
Description |
|
AssetVerificationDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
AssetToVerify |
0:NodeId |
Node identifier of the Asset to verify. |
|
VerificationMode |
2:AssetVerificationModeEnum |
The VerificationMode to use for verifying the Asset. |
|
ExpectedVerificationResult |
2:AssetVerificationResultEnum |
Expected Asset compatibility and/or identity. |
|
ExpectedVerificationVariables |
0:KeyValuePair[] |
A list of variables indicated by QualifiedName and their Value to be verified. |
|
ExpectedAdditionalVerificationVariables |
2:NodeIdValuePair[] |
A list of variables indicated by NodeId and their Value to be verified. |
The AssetVerificationDataType representation in the AddressSpace is formally defined in Table 122.
Table 122 – AssetVerificationDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:AssetVerificationDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX ConnectionManager Base |
||||||
This structure contains the result of Asset verification returned by the Method Call (e.g., EstablishConnections).
The structure is formally defined in Table 123.
Table 123 – AssetVerificationResultDataType structure
|
Name |
Type |
Description |
|
AssetVerificationResultDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
VerificationStatus |
0:StatusCode |
Indicates the operational status of the Asset verification method. If VerificationStatus is Bad, VerificationResult and VerificationVariablesErrors shall be ignored. |
|
VerificationResult |
2:AssetVerificationResultEnum |
|
|
VerificationVariablesErrors |
0:StatusCode[] |
If at least one element in ExpectedVerificationVariables caused an error (e.g., does not exist), this array will be of equal length to ExpectedVerificationVariables and contain corresponding StatusCodes (see 6.3.3). |
|
VerificationAdditionalVariablesErrors |
0:StatusCode[] |
If at least one element in ExpectedAdditionalVerificationVariables caused an error (e.g., does not exist), this array will be of equal length to ExpectedAdditionalVerificationVariables and contain corresponding StatusCodes (see 6.3.3). |
The AssetVerificationResultDataType representation in the AddressSpace is formally defined in Table 124.
Table 124 – AssetVerificationResultDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:AssetVerificationResultDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX ConnectionManager Base |
||||||
This enumeration represents the result of Asset verification.
The enumeration is formally defined in Table 125.
Table 125 – AssetVerificationResultEnum items
|
Name |
Value |
Description |
|
NotSet |
0 |
The verification result is not set. |
|
Match |
1 |
Asset matches expectation. |
|
Compatible |
2 |
Asset does not match expectations but is compatible. |
|
Mismatch |
3 |
Asset does not match expectations and is not compatible. |
The AssetVerificationResultEnum representation in the AddressSpace is formally defined in Table 126.
Table 126 – AssetVerificationResultEnum definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:AssetVerificationResultEnum |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Enumeration defined in OPC 10000-5 |
||||||
|
0:HasProperty |
Variable |
0:EnumValues |
0:EnumValueType[] |
0:PropertyType |
|
|
|
ConformanceUnits |
||||||
|
UAFX ConnectionManager Base |
||||||
|
UAFX AutomationComponent Base |
||||||
This enumeration is the default enumeration for the Kind Variable in the ClampType (see 6.3.7) and ClampBlockType (see 6.3.8). The enumeration is formally defined in Table 127.
Table 127 – ClampKindEnum items
|
Name |
Value |
Description |
|
Screw |
0 |
This is a screw connector |
|
Thumb |
1 |
This is a thumb connector |
The ClampKindEnum representation in the AddressSpace is formally defined in Table 128.
Table 128 – ClampKindEnum definition
|
Attribute |
Value |
||||
|
BrowseName |
3:ClampKindEnum |
||||
|
IsAbstract |
False |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:Enumeration defined in OPC 10000-5 |
|||||
|
0:HasProperty |
Variable |
0:EnumValues |
0:EnumValueType[] |
0:PropertyType |
|
|
ConformanceUnits |
|||||
|
UAFX AssetConnector Clamp Base |
|||||
This OptionSet defines flags indicating the health of the ConnectionEndpoints. The CommHealthOptionSet values are formally defined in Table 129.
Table 129 – CommHealthOptionSet values
|
Value |
Bit No. |
Description |
|
CommInitial |
0 |
At least one of the ConnectionEndpoints has its Status set to Initial. |
|
CommPreOperational |
1 |
At least one of the ConnectionEndpoints has its Status set to PreOperational. |
|
CommError |
2 |
At least one of the ConnectionEndpoints has its Status set to Error. |
Bits 3:15 are reserved for future use. The CommHealthOptionSet representation in the AddressSpace is formally defined in Table 130.
Table 130 – CommHealthOptionSet definition
|
Attribute |
Value |
||||
|
BrowseName |
3:CommHealthOptionSet |
||||
|
IsAbstract |
False |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:UInt16 type defined in OPC 10000-5 |
|||||
|
0:HasProperty |
Variable |
0:OptionSetValues |
0:LocalizedText[] |
0:PropertyType |
|
|
ConformanceUnits |
|||||
|
UAFX FunctionalEntity Base |
|||||
The CommunicationConfigurationDataType is an abstract structure used to provide the configuration of the communication model.
The CommunicationConfigurationDataType is illustrated in Figure 54.
Figure 54 – CommunicationConfigurationDataType illustration
The CommunicationConfigurationDataType is an abstract type that has no fields and is expected to be subtyped. It is formally defined in Table 131.
Table 131 – CommunicationConfigurationDataType definition
|
Attributes |
Value |
||
|
BrowseName |
2:CommunicationConfigurationDataType |
||
|
IsAbstract |
True |
||
|
References |
Node Class |
BrowseName |
Description |
|
Subtype of the 0:Structure defined in OPC 10000-5 |
|||
|
HasSubtype |
DataType |
2:PubSubCommunicationConfigurationDataType |
Defined in 10.10.3 |
|
ConformanceUnits |
|||
|
UAFX AutomationComponent Base |
|||
|
UAFX ConnectionManager Base |
|||
The PubSubCommunicationConfigurationDataType contains configuration information for the PubSub communication model. It is formally defined in Table 132.
Table 132 – PubSubCommunicationConfigurationDataType structure
|
Name |
Type |
Description |
|
PubSubCommunicationConfigurationDataType |
Structure |
Subtype of CommunicationConfigurationDataType |
|
PubSubConfiguration |
0:PubSubConfiguration2DataType |
The PubSubConfiguration to be applied. |
|
RequireCompleteUpdate |
0:Boolean |
For the definition, see CloseAndUpdate defined in OPC 10000-14. |
|
ConfigurationReferences |
0:PubSubConfigurationRefDataType[] |
For the definition, see CloseAndUpdate defined in OPC 10000-14. |
The PubSubCommunicationConfigurationDataType representation in the AddressSpace is formally defined in Table 133.
Table 133 – PubSubCommunicationConfigurationDataType definition
|
Attributes |
Value |
|||
|
BrowseName |
2:PubSubCommunicationConfigurationDataType |
|||
|
IsAbstract |
False |
|||
|
References |
NodeClass |
BrowseName |
IsAbstract |
Description |
|
Subtype of the 2:CommunicationConfigurationDataType |
||||
|
ConformanceUnits |
||||
|
UAFX AutomationComponent Base |
||||
|
UAFX ConnectionManager Base |
||||
Provides the configuration information for the Client Server communication model.
This DataType will be specified in a future version of this document.
The CommunicationConfigurationResultDataType is an abstract structure used to provide information regarding communication model-specific results and properties at the EstablishConnections Method.
The CommunicationConfigurationResultDataType is illustrated in Figure 55.
Figure 55 – CommunicationConfigurationResultDataType illustration
The CommunicationConfigurationResultDataType is an abstract type that has no structure and is expected to be subtyped. It is formally defined in Table 134.
Table 134 – CommunicationConfigurationResultDataType definition
|
Attributes |
Value |
||
|
BrowseName |
2:CommunicationConfigurationResultDataType |
||
|
IsAbstract |
True |
||
|
References |
Node Class |
BrowseName |
Description |
|
Subtype of the 0:Structure defined in OPC 10000-5 |
|||
|
HasSubtype |
DataType |
2:PubSubCommunicationConfigurationResultDataType |
Defined in 10.11.3 |
|
ConformanceUnits |
|||
|
UAFX AutomationComponent Base |
|||
|
UAFX ConnectionManager Base |
|||
The PubSubCommunicationConfigurationResultDataType is formally defined in Table 135.
Table 135 – PubSubCommunicationConfigurationResultDataType structure
|
Name |
Type |
Description |
|
PubSubCommunicationConfigurationResultDataType |
Structure |
Subtype of CommunicationConfigurationResultDataType |
|
Result |
0:StatusCode |
Status Code related to the overall configuration of the communication model. For the definition, see Table 19. |
|
ChangesApplied |
0:Boolean |
For the definition, see CloseAndUpdate defined in OPC 10000-14. If the command is aborted or rolled back, it shall be set to FALSE. |
|
ReferenceResults |
0:StatusCode[] |
For the definition, see CloseAndUpdate defined in OPC 10000-14. |
|
ConfigurationValues |
0:PubSubConfigurationValueDataType[] |
For the definition, see CloseAndUpdate defined in OPC 10000-14. |
|
ConfigurationObjects |
0:NodeId[] |
For the definition, see CloseAndUpdate defined in OPC 10000-14. If the command is aborted or rolled back, it shall be set to null or empty. |
The PubSubCommunicationConfigurationResultDataType representation in the AddressSpace is formally defined in Table 136.
Table 136 – PubSubCommunicationConfigurationResultDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:PubSubCommunicationConfigurationResultDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 2:CommunicationConfigurationResultDataType |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX ConnectionManager Base |
||||||
This DataType will be specified in a future version of this document.
This Structure DataType is used to describe an end-to-end QoS configuration for the CommunicationFlowConfiguration.
The CommunicationFlowQosDataType is formally defined in Table 137.
Table 137 – CommunicationFlowQosDataType structure
|
Name |
Type |
Description |
AllowSubtypes |
|
CommunicationFlowQosDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
|
QosCategory |
0:String |
Describes a QoS category, for example, best-effort or priority. For standard QosCategory values, see OPC 10000-14. Note that a null or empty QosCategory indicates Best Effort. |
False |
|
TransmitQos |
0:TransmitQosDataType[] |
The TransmitQos describes QoS category-related parameters for the Publisher. This array shall be null or empty if no QoS-related parameters are required or if no Publisher is defined. For the defined parameters, see OPC 10000-14. |
True |
|
ReceiveQos |
0:ReceiveQosDataType[] |
The ReceiveQos describes QoS category-related parameters for the Subscriber. This array shall be null or empty if no QoS-related parameters are required or if no Subscriber is defined. For the defined parameters, see OPC 10000-14. |
True |
The CommunicationFlowQosDataType representation in the AddressSpace is formally defined in Table 138.
Table 138 – CommunicationFlowQosDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
4:CommunicationFlowQosDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX ConnectionManager Base |
||||||
The CommunicationLinkConfigurationDataType is an abstract structure used by the EstablishConnections Method to provide the configuration of references between ConnectionEndpoints and Object instances specific to the utilized communication model.
The CommunicationLinkConfigurationDataType is illustrated in Figure 56.
Figure 56 – CommunicationLinkConfigurationDataType illustration
The CommunicationLinkConfigurationDataType is an abstract type that has no structure and is expected to be subtyped. It is formally defined in Table 139.
Table 139 – CommunicationLinkConfigurationDataType definition
|
Attributes |
Value |
||
|
BrowseName |
2:CommunicationLinkConfigurationDataType |
||
|
IsAbstract |
True |
||
|
References |
Node Class |
BrowseName |
Description |
|
Subtype of the 0:Structure defined in OPC 10000-5 |
|||
|
HasSubtype |
DataType |
2:PubSubCommunicationLinkConfigurationDataType |
Defined in 10.13.3 |
|
ConformanceUnits |
|||
|
UAFX AutomationComponent Base |
|||
|
UAFX ConnectionManager Base |
|||
The PubSubCommunicationLinkConfigurationDataType is used by the EstablishConnections Method and provides the configuration of references between a ConnectionEndpoint and a DataSetReader and/or a DataSetWriter.
NOTE The PubSub configuration elements, including the DataSetReader and/or DataSetWriter to be used for the ConnectionEndpoints, are created using the PubSubCommunicationConfigurationDataType (see 10.10.3).
The PubSubCommunicationLinkConfigurationDataType is formally defined in Table 140.
Table 140 – PubSubCommunicationLinkConfigurationDataType structure
|
Name |
Type |
Description |
|
PubSubCommunicationLinkConfigurationDataType |
Structure |
Subtype of CommunicationLinkConfigurationDataType |
|
DataSetReaderRef |
0:PubSubConfigurationRefDataType |
If not null, specifies the DataSetReader as supplied with the PubSubCommunicationConfigurationDataType. The ConfigurationMask shall contain a ReferenceReader bit only. |
|
ExpectedSubscribedDataSetVersion |
0:ConfigurationVersionDataType |
Specifies the expected ConfigurationVersion of the SubscribedDataSet’s DataSetMetaData. For heartbeat, the MajorVersion and the MinorVersion shall be set to 0. |
|
DataSetWriterRef |
0:PubSubConfigurationRefDataType |
If not null, specifies the DataSetWriter as supplied with the PubSubCommunicationConfigurationDataType. The ConfigurationMask shall contain a ReferenceWriter bit only. |
|
ExpectedPublishedDataSetVersion |
0:ConfigurationVersionDataType |
Specifies the expected ConfigurationVersion of the PublishedDataSet’s DataSetMetaData. For heartbeat, the MajorVersion and the MinorVersion shall be set to 0. |
The PubSubCommunicationLinkConfigurationDataType representation in the AddressSpace is formally defined in Table 141.
Table 141 – PubSubCommunicationLinkConfigurationDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:PubSubCommunicationLinkConfigurationDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 2:CommunicationLinkConfigurationDataType |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX ConnectionManager Base |
||||||
Provides the configuration of references between ConnectionEndpoints and Object instances specific to the Client Server communication model.
This DataType will be specified in a future version of this document.
This structure is semantically equivalent to the ConnectionEndpointConfigurationType as defined in 6.10.2.
The structure is formally defined in Table 142.
Table 142 – ConnectionEndpointConfigurationDataType structure
|
Name |
Type |
Description |
AllowSubtypes |
|
ConnectionEndpointConfigurationDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
|
FunctionalEntityNode |
0:NodeId |
NodeId of the FunctionalEntity to connect. |
False |
|
ConnectionEndpoint |
2:ConnectionEndpointDefinitionDataType |
Specifies either the information for the ConnectionEndpoint to be created or the NodeId of an existing ConnectionEndpoint. This ConnectionEndpoint is contained in the FunctionalEntity referenced by FunctionalEntityNode. If this parameter is to be omitted, it shall be set to null. |
False |
|
ExpectedVerificationVariables |
2:NodeIdValuePair[] |
Specifies the expected verification variables for the FunctionalEntityNode. If this parameter is to be omitted, it shall be set to null or empty. |
False |
|
ControlGroups |
0:NodeId[] |
Specifies the ControlGroups to be controlled by the ConnectionEndpoint. If this parameter is to be omitted, it shall be set to null or empty. |
False |
|
ConfigurationData |
2:NodeIdValuePair[] |
Specifies the ConfigurationData to be applied. If this parameter is to be omitted, it shall be set to null or empty. |
False |
|
CommunicationLinks |
2:CommunicationLinkConfigurationDataType |
Specifies the references to the communication model instances to be set for the ConnectionEndpoint. If this parameter is to be omitted, it shall be set to null. |
True |
The ConnectionEndpointConfigurationDataType representation in the AddressSpace is formally defined in Table 143.
Table 143 – ConnectionEndpointConfigurationDataType definition
|
Attribute |
Value |
||||||
|
BrowseName |
2:ConnectionEndpointConfigurationDataType |
||||||
|
IsAbstract |
False |
||||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
||
|
Subtype of the 0:Structure defined in OPC 10000-5 |
|||||||
|
ConformanceUnits |
|||||||
|
UAFX AutomationComponent Base |
|||||||
|
UAFX ConnectionManager Base |
|||||||
For a definition of how this DataType shall be generated by the ConnectionManager, see 6.7.5.3. For a definition of how this DataType is interpreted by the EstablishConnections Method, see 6.2.4.
This structure contains the results returned from the ConnectionEndpoint configuration by the EstablishConnections Method. For a definition of how this DataType is used by the EstablishConnections Method, see 6.2.4.
The structure is formally defined in Table 144.
Table 144 – ConnectionEndpointConfigurationResultDataType structure
|
Name |
Type |
Description |
|
ConnectionEndpointConfigurationResultDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
ConnectionEndpointId |
0:NodeId |
The NodeId of the ConnectionEndpoint. If the command is aborted or rolled back, it shall be set to null. |
|
FunctionalEntityNodeResult |
0:StatusCode |
StatusCode related to the FunctionalEntityNode. |
|
ConnectionEndpointResult |
0:StatusCode |
StatusCode related to the ConnectionEndpoint. |
|
VerificationResult |
2:FunctionalEntityVerificationResultEnum |
Result of the identity check. If CommandMask VerifyFunctionalEntityCmd is not set, it shall be set to NotSet. |
|
VerificationStatus |
0:StatusCode |
Operational status related to identity-check of the FunctionalEntityNode. If CommandMask VerifyFunctionalEntityCmd is not set, it shall be set to Good. |
|
VerificationVariablesErrors |
0:StatusCode[] |
Variables errors related to the identity-check of the FunctionalEntityNode. If CommandMask VerifyFunctionalEntityCmd is not set, it shall be null or empty. |
|
EstablishControlResult |
0:StatusCode[] |
StatusCodes related to EstablishControl on the ControlGroup(s). If CommandMask EstablishControlCmd is set, the length of this array shall match the length of ControlGroups, and each element shall contain the result of the corresponding element in ControlGroups. If CommandMask EstablishControlCmd is not set, it shall be null or empty. |
|
ConfigurationDataResult |
0:StatusCode[] |
StatusCodes related to applying ConfigurationData. If CommandMask SetConfigurationDataCmd is set, the length of this array shall match the length of ConfigurationData, and each element shall contain the result of the corresponding element in ConfigurationData. If CommandMask SetConfigurationDataCmd is not set, it shall be null or empty. |
|
ReassignControlResult |
0:StatusCode[] |
StatusCodes related to ReassignControl on the ControlGroup(s). If CommandMask ReassignControlCmd is set, the length of this array shall match the length of ControlGroups, and each element shall contain the result of the corresponding element in ControlGroups. If CommandMask ReassignControlCmd is not set, it shall be null or empty. |
|
CommunicationLinksResult |
0:StatusCode |
StatusCode related to establishing references into the communication model.If CommandMask SetCommunicationConfigurationCmd is not set, it shall be set to Good. |
|
EnableCommunicationResult |
0:StatusCode |
Status Code related to the overall enabling of the communication model. If CommandMask EnableCommunicationConfigurationCmd is not set, it shall be set to Good. |
The ConnectionEndpointConfigurationResultDataType representation in the AddressSpace is formally defined in Table 145.
Table 145 – ConnectionEndpointConfigurationResultDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:ConnectionEndpointConfigurationResultDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX ConnectionManager Base |
||||||
The ConnectionEndpointDefinitionDataType is formally defined in Table 146.
Table 146 – ConnectionEndpointDefinitionDataType structure
|
Name |
Type |
Description |
AllowSubtypes |
|
ConnectionEndpointDefinitionDataType |
Union |
Subtype of Union defined in OPC 10000-5 |
|
|
Parameter |
2:ConnectionEndpointParameterDataType |
Parameter holds the parameters to be used for the creation of the ConnectionEndpoint or for the use of a preconfigured ConnectionEndpoint. This element is used when calling EstablishConnections with the CreateConnectionEndpointCmd. |
True |
|
Node |
0:NodeId |
The NodeId of the ConnectionEndpoint to use. This element is used when calling EstablishConnections without the CreateConnectionEndpointCmd (e.g., in a subsequent Call). |
False |
The ConnectionEndpointDefinitionDataType representation in the AddressSpace is formally defined in Table 147.
Table 147 – ConnectionEndpointDefinitionDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:ConnectionEndpointDefinitionDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Union defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX ConnectionManager Base |
||||||
This enumeration defines the values of the Status of a ConnectionEndpointType. The enumeration is formally defined in Table 148.
Table 148 – ConnectionEndpointStatusEnum items
|
Name |
Value |
Description |
|
Initial |
0 |
Initial status of the logical connection. No communication-model o bjects referenced. |
|
Ready |
1 |
Logical connection is ready to operate; communication-model objects are referenced but not enabled. |
|
PreOperational |
2 |
PreOperational status of the logical connection: Data output is active, but no input data received. |
|
Operational |
3 |
Operational status of the logical connection: Data output is active, and input data has been received. |
|
Error |
4 |
The logical connection has encountered an Error. |
The ConnectionEndpointStatusEnum representation in the AddressSpace is formally defined in Table 149.
Table 149 – ConnectionEndpointStatusEnum definition
|
Attribute |
Value |
||||
|
BrowseName |
3:ConnectionEndpointStatusEnum |
||||
|
IsAbstract |
False |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:Enumeration type defined in OPC 10000-5 |
|||||
|
0:HasProperty |
Variable |
0:EnumValues |
0:EnumValueType[] |
0:PropertyType |
|
|
ConformanceUnits |
|||||
|
UAFX AutomationComponent Base |
|||||
The ConnectionEndpointParameterDataType is an abstract structure used by the EstablishConnections Method to provide the information for creation of a ConnectionEndpoint. It is semantically equivalent to the ConnectionEndpointParameterType as defined in 6.12.
The ConnectionEndpointParameterDataType is illustrated in Figure 57.
Figure 57 – ConnectionEndpointParameterDataType illustration
The ConnectionEndpointParameterDataType is formally defined in Table 150.
Table 150 – ConnectionEndpointParameterDataType structure
|
Name |
Type |
Description |
|
ConnectionEndpointParameterDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
Name |
0:String |
Specifies the BrowseName of the ConnectionEndpoint. |
|
ConnectionEndpointTypeId |
0:NodeId |
Specifies the well-known NodeId of the type definition, which shall be used to create the ConnectionEndpoint. This can be any of the subtypes of the ConnectionEndpointType (for example, PubSubConnectionEndpointType) |
|
InputVariableIds |
0:NodeId[] |
Specifies a list of NodeIds that are inputs. If InputVariables are not provided, it shall be null or empty. |
|
OutputVariableIds |
0:NodeId[] |
Specifies a list of NodeIds that are outputs. If OutputVariables are not provided, it shall be null or empty. |
|
IsPersistent |
0:Boolean |
If TRUE, specifies the ConnectionEndpoint shall be persistent. |
|
CleanupTimeout |
0:Duration |
Specifies the value of the CleanupTimeout variable. |
|
RelatedEndpoint |
2:RelatedEndpointDataType |
Specifies the other endpoint this ConnectionEndpoint is connected to. |
|
IsPreconfigured |
0:Boolean |
If TRUE, specifies the ConnectionEndpoint is preconfigured. |
The ConnectionEndpointParameterDataType representation in the AddressSpace is formally defined in Table 151.
Table 151 – ConnectionEndpointParameterDataType definition
|
Attribute |
Value |
|||
|
BrowseName |
2:ConnectionEndpointParameterDataType |
|||
|
IsAbstract |
True |
|||
|
References |
NodeClass |
BrowseName |
Definition |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||
|
HasSubtype |
DataType |
PubSubConnectionEndpointParameterDataType |
Defined in 10.18.3 |
|
|
ConformanceUnits |
||||
|
UAFX AutomationComponent Base |
||||
|
UAFX ConnectionManager Base |
||||
The PubSubConnectionEndpointParameterDataType is used by the EstablishConnections Method to create a PubSubConnectionEndpoint.
The PubSubConnectionEndpointParameterDataType is formally defined in Table 152.
Table 152 – PubSubConnectionEndpointParameterDataType structure
|
Name |
Type |
Description |
|
PubSubConnectionEndpointParameterDataType |
Structure |
Subtype of ConnectionEndpointParameterDataType |
|
Mode |
2:PubSubConnectionEndpointModeEnum |
Indicates the intended mode of the ConnectionEndpoint. |
The PubSubConnectionEndpointParameterDataType representation in the AddressSpace is formally defined in Table 153.
Table 153 – PubSubConnectionEndpointParameterDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:PubSubConnectionEndpointParameterDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 2:ConnectionEndpointParameterDataType |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX ConnectionManager Base |
||||||
The ClientServerConnectionEndpointParameterDataType is used by the EstablishConnections Method to create a ClientServerConnectionEndpoint.
This DataType will be specified in a future version of this document.
This OptionSet defines flags indicating the aggregated health of the Assets. The DeviceHealthOptionSet values are formally defined in Table 154.
Table 154 – DeviceHealthOptionSet values
|
Value |
Bit No. |
Description |
|
DeviceFailure |
0 |
At least one of the top-level Assets has its DeviceHealth set to Failure. |
|
DeviceCheckFunction |
1 |
At least one of the top-level Assets has its DeviceHealth set to Check_Function. |
|
DeviceMaintenanceRequired |
2 |
At least one of the top-level Assets has its DeviceHealth set to Maintenance_Required. |
|
DeviceOffSpec |
3 |
At least one of the top-level Assets has its DeviceHealth set to Off_Spec. |
Bits 4:15 are reserved for future use. The DeviceHealthOptionSet representation in the AddressSpace is formally defined in Table 155.
Table 155 – DeviceHealthOptionSet definition
|
Attribute |
Value |
||||
|
BrowseName |
3:DeviceHealthOptionSet |
||||
|
IsAbstract |
False |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:UInt16 type defined in OPC 10000-5 |
|||||
|
0:HasProperty |
Variable |
0:OptionSetValues |
0:LocalizedText[] |
0:PropertyType |
|
|
ConformanceUnits |
|||||
|
UAFX AutomationComponent Base |
|||||
This enumeration represents the result of FunctionalEntity verification. The enumeration is formally defined in Table 156.
Table 156 – FunctionalEntityVerificationResultEnum items
|
Name |
Value |
Description |
|
NotSet |
0 |
The verification result is not set. |
|
Match |
1 |
FunctionalEntity matches expectation. |
|
Mismatch |
2 |
FunctionalEntity does not match expectation. |
The FunctionalEntityVerificationResultEnum representation in the AddressSpace is formally defined in Table 157.
Table 157 – FunctionalEntityVerificationResultEnum definition
|
Attribute |
Value |
||||
|
BrowseName |
2:FunctionalEntityVerificationResultEnum |
||||
|
IsAbstract |
False |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:Enumeration defined in OPC 10000-5 |
|||||
|
0:HasProperty |
Variable |
0:EnumValues |
0:EnumValueType[] |
0:PropertyType |
|
|
ConformanceUnits |
|||||
|
UAFX AutomationComponent Base |
|||||
|
UAFX ConnectionManager Base |
|||||
This OptionSet defines flags indicating the commands a ConnectionManager may use in its Call to the EstablishConnections Method.
The FxCommandMask values are formally defined in Table 158.
Table 158 – FxCommandMask values
|
Value |
Bit No. |
Description |
|
VerifyAssetCmd |
0 |
The addressed Server shall verify compatibility and/or identity for all requested Assets. |
|
VerifyFunctionalEntityCmd |
1 |
The addressed Server shall verify compatibility for all requested functional entities. |
|
CreateConnectionEndpointCmd |
2 |
The addressed Server shall create or modify ConnectionEndpoints. |
|
EstablishControlCmd |
3 |
The addressed Server shall establish control over the requested ControlGroups. |
|
SetConfigurationDataCmd |
4 |
The addressed Server shall apply the supplied application configuration. |
|
ReassignControlCmd |
5 |
The addressed Server shall reassign the requested ControlGroups |
|
ReserveCommunicationIdsCmd |
6 |
The addressed Server shall reserve identifiers for the communication model configuration. |
|
SetCommunicationConfigurationCmd |
7 |
The addressed Server shall apply the supplied communication model configuration. |
|
EnableCommunicationCmd |
8 |
The addressed Server shall enable the communication configuration. |
Bits 9:31 are reserved for future use. The FxCommandMask representation in the AddressSpace is formally defined in Table 159.
Table 159 – FxCommandMask definition
|
Attribute |
Value |
||||
|
BrowseName |
2:FxCommandMask |
||||
|
IsAbstract |
False |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:UInt32 type defined in OPC 10000-5 |
|||||
|
0:HasProperty |
Variable |
0:OptionSetValues |
0:LocalizedText[] |
0:PropertyType |
|
|
ConformanceUnits |
|||||
|
UAFX AutomationComponent Base |
|||||
|
UAFX ConnectionManager Base |
|||||
This enumeration defines the editing behaviour for a ConnectionManager. FxEditEnum is formally defined in Table 160.
|
Name |
Value |
Description |
|
StartEditing |
0 |
The ConnectionManager shall allow editing of the ConnectionConfigurationSets. |
|
CommitUpdates |
1 |
The ConnectionManager shall commit all updates from the ConnectionConfigurationSets. |
|
DiscardUpdates |
2 |
The ConnectionManager shall discard the updates to the ConnectionConfigurationSets. |
The FxEditEnum representation in the AddressSpace is formally defined in Table 161.
Table 161 – FxEditEnum definition
|
Attribute |
Value |
|||||
|
BrowseName |
4:FxEditEnum |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Enumeration type defined in OPC 10000-5 |
||||||
|
0:HasProperty |
Variable |
0:EnumValues |
0:EnumValueType[] |
0:PropertyType |
|
|
|
ConformanceUnits |
||||||
|
UAFX ConnectionManager Base |
||||||
This enumeration defines the processing behaviour of a ConnectionManager. FxProcessEnum is formally defined in Table 162.
Table 162 – FxProcessEnum values
The representation in the AddressSpace is formally defined in Table 163.
Table 163 – FxProcessEnum definition
|
Attribute |
Value |
|||||
|
BrowseName |
4:FxProcessEnum |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Enumeration type defined in OPC 10000-5 |
||||||
|
0:HasProperty |
Variable |
0:EnumValues |
0:EnumValueType[] |
0:PropertyType |
|
|
|
ConformanceUnits |
||||||
|
UAFX ConnectionManager Base |
||||||
This enumeration describes the support units of time. The enumeration is formally defined in Table 164.
Table 164 – FxTimeUnitsEnum items
|
Name |
Value |
Description |
|
Nanosecond |
0 |
The unit of time is nanoseconds |
|
Microsecond |
1 |
The unit of time is microseconds |
|
Millisecond |
2 |
The unit of time is milliseconds |
|
Second |
3 |
The unit of time is seconds |
The FxTimeUnitsEnum representation in the AddressSpace is formally defined in Table 165.
Table 165 – FxTimeUnitsEnum definition
|
Attribute |
Value |
||||
|
BrowseName |
3:FxTimeUnitsEnum |
||||
|
IsAbstract |
False |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:Enumeration type defined in OPC 10000-5 |
|||||
|
0:HasProperty |
Variable |
0:EnumStrings |
0:LocalizedText[] |
0:PropertyType |
|
|
ConformanceUnits |
|||||
|
UAFX AutomationComponent Base |
|||||
This structure contains version information that can be assigned to any Object or Variable that needs to store version information.
The structure is formally defined in Table 166.
Table 166 – FxVersion structure
|
Name |
Type |
Description |
|
FxVersion |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
Major |
0:UInt16 |
The major version number |
|
Minor |
0:UInt16 |
The minor version number |
|
Build |
0:UInt16 |
The build version number |
|
SubBuild |
0:UInt16 |
The sub-build version number |
The FxVersion representation in the AddressSpace is formally defined in Table 167.
Table 167 – FxVersion definition
|
Attribute |
Value |
|||||
|
BrowseName |
3:FxVersion |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX AcDescriptor DescriptorIdentifier |
||||||
|
UAFX FunctionalEntity Base |
||||||
The IntervalRange is a structure used to define a range of timing intervals.
The IntervalRange is formally defined in Table 168.
Table 168 – IntervalRange structure
|
Name |
Type |
Description |
|
IntervalRange |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
Min |
0:UInt32 |
The minimum interval (in units). |
|
Max |
0:UInt32 |
The maximum interval (in units). For linear ranges: Max = Min + N * Increment For exponential ranges: Max = Min * Multiplier Where N is an unsigned integer. |
|
Increment |
0:UInt16 |
The increment from minimum to maximum. An Increment value greater than or equal to 1 indicates a linear IntervalRange; in this case, Multiplier shall be set to 1. 0 indicates no increment. |
|
Multiplier |
0:UInt16 |
The multiplier that can be applied. Multiplier shall be greater than or equal to 1. A value of 2 or greater indicates an exponential IntervalRange; in this case, Increment shall be set to 0. 1 indicates no multiplier. |
|
Unit |
3:FxTimeUnitsEnum |
IntervalRange allows specifying
- linear ranges: [Min, Min + Increment, Min + 2 * Increment, Min + 3 * Increment… Max]
- exponential ranges: [Min, Min * Multiplier, Min * Multiplier 2, Min * Multiplier 3, …, Max]
- fixed range: if Min is equal to Max.
For example, an IntervalRange with Min=2, Max=16, Increment=2 and Unit=milliseconds result in the following linear range: [2 ms, 4 ms, 6 ms, 8 ms, 10 ms, 12 ms, 14 ms, 16 ms]. An IntervalRange with Min=125, Max=1000, Multiplier=2 and Unit=microseconds result in the following exponential range: [125 µs, 250 µs, 500 µs, 1000 µs].
A null IntervalRange is indicated by setting Min, Max, to 0.
The IntervalRange representation in the AddressSpace is formally defined in Table 169.
Table 169 – IntervalRange definition
|
Attribute |
Value |
|||||
|
BrowseName |
3:IntervalRange |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX FunctionalEntity Base |
||||||
This structured DataType is used to provide a NodeId and can specify a single element within a Variable that is of array type. One or more index values must be specified to identify the specific element.
The structure is formally defined in Table 170.
Table 170 – NodeIdArray structure
|
Name |
Type |
Description |
|
NodeIdArray |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
Node |
0:NodeId |
The NodeId that is to be processed. |
|
ArrayIndex |
0:UInt32[] |
If NodeId refers to a Node of array type, the ArrayIndex specifies the index for a specific value referenced by the NodeId (not the entire array, but a specific element in it). The size of ArrayIndex shall be equal to the number of dimensions of the Node. If NodeId is not of array type, or if all elements are referenced, then ArrayIndex shall be null or empty. |
The NodeIdArray representation in the AddressSpace is formally defined in Table 171.
Table 171 – NodeIdArray definition
|
Attribute |
Value |
||||
|
BrowseName |
2:NodeIdArray |
||||
|
IsAbstract |
False |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:Structure defined in OPC 10000-5 |
|||||
|
ConformanceUnits |
|||||
|
UAFX AutomationComponent Base |
|||||
|
UAFX ConnectionManager Base |
|||||
This structured DataType is used to provide a NodeId value pair. The NodeIdValuePair specifies a KeyValuePair with a NodeIdArray as key.
The structure is formally defined in Table 172.
Table 172 – NodeIdValuePair structure
|
Name |
Type |
Description |
|
NodeIdValuePair |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
Key |
2:NodeIdArray |
The key to the item. To reference a single item or an array element, a scalar Value shall be provided. |
|
Value |
0:BaseDataType |
Specifies the value, which can be of any DataType. If the value is an array, then the entire array is processed. |
The NodeIdValuePair representation in the AddressSpace is formally defined in Table 173.
Table 173 – NodeIdValuePair definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:NodeIdValuePair |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX ConnectionManager Base |
||||||
This structured DataType is used to provide table entries for conversion of NodeId to PortableNodeIdentifier (see 6.16.3).
The structure is formally defined in Table 174.
Table 174 – NodeIdTranslationDataType structure
|
Name |
Type |
Description |
|
NodeIdTranslationDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
NodePlaceholder |
0:NodeId |
NodeId to be converted to the result of resolving the PortableNodeIdentifier. |
|
PortableNode |
4:PortableNodeIdentifier |
Specifies the PortableNodeIdentifier corresponding to the NodeId of the NodePlaceholder. |
The NodeIdTranslationDataType representation in the AddressSpace is formally defined in Table 175.
Table 175 – NodeIdTranslationDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
4:NodeIdTranslationDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX ConnectionManager Base |
||||||
This OptionSet defines flags indicating the health of a FunctionalEntity. The OperationalHealthOptionSet values are formally defined in Table 176.
Table 176 – OperationalHealthOptionSet values
|
Value |
Bit No. |
Description |
|
Reserved |
0:15 |
Used by CommHealthOptionSet defined in 10.9 |
|
OperationalWarning |
16 |
FunctionalEntity indicates a warning. |
|
OperationalError |
17 |
FunctionalEntity indicates an error. |
|
SubOperationalWarning |
18 |
One of the SubFunctionalEntities indicates a warning. |
|
SubOperationalError |
19 |
One of the SubFunctionalEntities indicates an error. |
Bits 0:15 contain an aggregation of the CommHealthOptionSet (see 10.9) from the associated ConnectionEndpoints (definition is repeated here for tools). Bits 16-19 represent the FunctionalEntity status and, if present, from SubFunctionalEntities. Bits 20-31 are reserved for future use. The OperationalHealthOptionSet representation in the AddressSpace is formally defined in Table 177.
Table 177 – OperationalHealthOptionSet definition
|
Attribute |
Value |
||||
|
BrowseName |
3:OperationalHealthOptionSet |
||||
|
IsAbstract |
False |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:UInt32 type defined in OPC 10000-5 |
|||||
|
0:HasProperty |
Variable |
0:OptionSetValues |
0:LocalizedText[] |
0:PropertyType |
|
|
ConformanceUnits |
|||||
|
UAFX AutomationComponent Base |
|||||
This structured DataType is used to provide a portable key-value pair. The PortableKeyValuePair is used to store a KeyValuePair outside the context of where the Node is located, using a portable QualifiedName as a key.
The structure is formally defined in Table 178.
Table 178 – PortableKeyValuePair structure
|
Name |
Type |
Description |
|
PortableKeyValuePair |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
Key |
0:PortableQualifiedName |
The key of the value. |
|
Value |
0:BaseDataType |
The value associated with the key. |
The PortableKeyValuePair representation in the AddressSpace is formally defined in Table 179.
Table 179 – PortableKeyValuePair definition
|
Attribute |
Value |
|||||
|
BrowseName |
4:PortableKeyValuePair |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX ConnectionManager Base |
||||||
The PortableNodeIdentifier is used to store an identification to a Node outside the context of where the Node is located, using a portable NodeId, an Alias, or a portable RelativePath.
The PortableNodeIdentifier DataType is formally defined in Table 180.
Table 180 – PortableNodeIdentifier union
|
Name |
Type |
Description |
|
PortableNodeIdentifier |
Union |
Subtype of Union defined in OPC 10000-5 |
|
Node |
0:PortableNodeId |
The NodeId of the item |
|
Alias |
0:String |
The AliasName of the Item |
|
IdentifierBrowsePath |
4:PortableRelativePath |
The IdentifierBrowsePath to the item. The starting node of the IdentifierBrowsePath shall be specified where this type is used. |
The PortableNodeIdentifier representation in the AddressSpace is formally defined in Table 181.
Table 181 – PortableNodeIdentifier definition
|
Attribute |
Value |
|||||
|
BrowseName |
4:PortableNodeIdentifier |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Union defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX ConnectionManager Base |
||||||
This structured DataType is used to provide a key-value pair for storage outside the context of where the Node is located, using a PortableNodeIdentifier as the key.
The structure is formally defined in Table 182.
Table 182 – PortableNodeIdentifierValuePair structure
|
Name |
Type |
Description |
|
PortableNodeIdentifierValuePair |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
Key |
4:PortableNodeIdentifier |
The key to the item. |
|
ArrayIndex |
0:UInt32[] |
If Key refers to a Node of array type, the ArrayIndex specifies the index for a specific value referenced by Key (Not the entire array, but a specific element in it). The ArrayIndex is required to have the same dimension as the dimension of the node. If Key is not of array type, or if no specific index is referenced, then the array shall be null or empty. |
|
Value |
0:BaseDataType |
The value associated with the key/array item. |
The PortableNodeIdentifierValuePair representation in the AddressSpace is formally defined in Table 183.
Table 183 – PortableNodeIdentifierValuePair definition
|
Attribute |
Value |
|||||
|
BrowseName |
4:PortableNodeIdentifierValuePair |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX ConnectionManager Base |
||||||
This structure contains a PortableRelativePath, which defines a sequence of References and BrowseNames to follow for storing a relative path outside the context of where the target of the relative path is located. It is semantically equivalent to RelativePath.
The PortableRelativePath DataType is formally defined in Table 184.
Table 184 – PortableRelativePath structure
|
Name |
Type |
Description |
|
PortableRelativePath |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
Elements |
4:PortableRelativePathElement[] |
A sequence of References and BrowseNames to follow. This array defines a sequence of elements. Each element in the sequence is processed by finding the targets and then using those targets as the starting nodes for the next element. The target of the final element is the target of the PortableRelativePath. |
A PortableRelativePath can be applied to any starting Node. The targets of the PortableRelativePath are the set of Nodes that are found by sequentially following the elements in PortableRelativePath.
A PortableRelativePath is set to null by setting Elements to null or empty.
The PortableRelativePath representation in the AddressSpace is formally defined in Table 185.
Table 185 – PortableRelativePath definition
|
Attribute |
Value |
|||||
|
BrowseName |
4:PortableRelativePath |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX ConnectionManager Base |
||||||
This structure contains an element of the PortableRelativePath.
The PortableRelativePathElement DataType is formally defined in Table 186.
Table 186 – PortableRelativePathElement structure
|
Name |
Type |
Description |
|
PortableRelativePathElement |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
ReferenceTypeId |
0:PortableNodeId |
The type of Reference to follow from the current node. The current path cannot be followed any further if the ReferenceTypeId is not available on the Node instance. If not specified, then all References are included, and the parameter IncludeSubtypes is ignored. |
|
IsInverse |
0:Boolean |
Only inverse references shall be followed if this value is TRUE. Only forward references shall be followed if this value is FALSE. |
|
IncludeSubtypes |
0:Boolean |
Indicates whether subtypes of the ReferenceType should be followed. Subtypes are included if this value is TRUE. |
|
TargetName |
0:PortableQualifiedName |
The BrowseName of the target node. The final element may have an empty TargetName. In this situation, all targets of the references identified by the ReferenceTypeId are the targets of the PortableRelativePathElement. The TargetName shall be specified for all other elements. The current path cannot be followed any further if no targets with the specified PortableQualifiedName exist. |
The PortableRelativePathElement representation in the AddressSpace is formally defined in Table 187.
Table 187 – PortableRelativePathElement definition
|
Attribute |
Value |
|||||
|
BrowseName |
4:PortableRelativePathElement |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX ConnectionManager Base |
||||||
This Structure DataType is used to describe a QoS capability.
The PublisherQosDataType is formally defined in Table 188.
Table 188 – PublisherQosDataType structure
|
Name |
Type |
Description |
AllowSubtypes |
|
PublisherQosDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
|
QosCategory |
0:String |
Describes a QoS category, for example, best-effort or priority. For standard QosCategory values, see OPC 10000-14. Note that a null or empty QosCategory indicates Best Effort. |
False |
|
DatagramQos |
0:TransmitQosDataType[] |
The DatagramQos describes QoS category-related parameters. This array shall be null or empty if no QoS-related parameters are needed. For the defined parameters, see OPC 10000-14. |
True |
The PublisherQosDataType representation in the AddressSpace is formally defined in Table 189.
Table 189 – PublisherQosDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
3:PublisherQosDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX FunctionalEntity Base |
||||||
.
This enumeration defines the possible values of the Mode of the PubSubConnectionEndpointType. The enumeration is formally defined in Table 190.
Table 190 – PubSubConnectionEndpointModeEnum items
|
Name |
Value |
Description |
|
PublisherSubscriber |
1 |
Reference to DataSetReader and DataSetWriter required. |
|
Publisher |
2 |
Reference to DataSetWriter is required. |
|
Subscriber |
3 |
Reference to DataSetReader is required. |
The PubSubConnectionEndpointModeEnum representation in the AddressSpace is formally defined in Table 191.
Table 191 – PubSubConnectionEndpointModeEnum definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:PubSubConnectionEndpointModeEnum |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Enumeration type defined in OPC 10000-5 |
||||||
|
0:HasProperty |
Variable |
0:EnumValues |
0:EnumValueType[] |
0:PropertyType |
|
|
|
ConformanceUnits |
||||||
|
UAFX ConnectionEndpoint PubSub |
||||||
|
UAFX ConnectionManager Base |
||||||
This structure DataType holds the information for the related instance of ConnectionEndpointType, serving as the “other end” of the Connection.
The RelatedEndpointDataType is formally defined in Table 192.
Table 192 – RelatedEndpointDataType structure
|
Name |
Type |
Description |
|
RelatedEndpointDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
Address |
0:UriString |
Specifies the Server’s address as DiscoveryUrl in the form “scheme://hostname[:port][/path]” as defined in OPC 10000-12. |
|
ConnectionEndpointPath |
0:PortableQualifiedName[] |
Specifies the series of PortableQualifiedNames to the FunctionalEntity. This path starts at FxRoot. |
|
ConnectionEndpointName |
0:String |
The name of the ConnectionEndpoint. In case an AutomationComponent does not expose ConnectionEndpoints in its Information Model, ConnectionEndpointName is set to null. |
A RelatedEndpointDataType is set to null by setting ConnectionEndpoint to null or empty and the Address to null.
The RelatedEndpointDataType representation in the AddressSpace is formally defined in Table 193.
Table 193 – RelatedEndpointDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:RelatedEndpointDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX ConnectionEndpoint Base |
||||||
|
UAFX ConnectionManager Base |
||||||
The ReserveCommunicationIdsDataType is an abstract structure used to request communication model-specific identifiers using the EstablishConnections Method.
The ReserveCommunicationIdsDataType is illustrated in Figure 58.
Figure 58 – ReserveCommunicationIdsDataType illustration
The ReserveCommunicationIdsDataType is an abstract type that has no structure and is expected to be subtyped. It is formally defined in Table 194.
Table 194 – ReserveCommunicationIdsDataType definition
|
Attributes |
Value |
||
|
BrowseName |
2:ReserveCommunicationIdsDataType |
||
|
IsAbstract |
True |
||
|
References |
Node Class |
BrowseName |
Description |
|
Subtype of the 0:Structure defined in OPC 10000-5 |
|||
|
HasSubtype |
DataType |
2:PubSubReserveCommunicationIdsDataType |
Defined in 10.39.3 |
|
ConformanceUnits |
|||
|
UAFX AutomationComponent Base |
|||
|
UAFX ConnectionManager Base |
|||
The PubSubReserveCommunicationIdsDataType is formally defined in Table 195.
Table 195 – PubSubReserveCommunicationIdsDataType structure
|
Name |
Type |
Description |
|
PubSubReserveCommunicationIdsDataType |
Structure |
Subtype of ReserveCommunicationIdsDataType |
|
TransportProfileUri |
0:String |
See OPC 10000-14 for details |
|
NumReqWriterGroupIds |
0:UInt16 |
Indicates the number of requested node ids for WriterGroups. |
|
NumReqDataSetWriterIds |
0:UInt16 |
Indicates the number of requested node ids for DataSetWriter. |
The PubSubReserveCommunicationIdsDataType representation in the AddressSpace is formally defined in Table 196.
Table 196 – PubSubReserveCommunicationIdsDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:PubSubReserveCommunicationIdsDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 2:ReserveCommunicationIdsDataType |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX ConnectionManager Base |
||||||
This data type will be specified in a later version of this document.
The ReserveCommunicationIdsResultDataType is an abstract structure used to return the requested communication model-specific identifier from the EstablishConnections Method.
The ReserveCommunicationIdsResultDataType is illustrated in Figure 59.
Figure 59 – ReserveCommunicationIdsResultDataType illustration
The ReserveCommunicationIdsResultDataType, formally defined in Table 197, is an abstract type that has no structure and is expected to be subtyped.
Table 197 – ReserveCommunicationIdsResultDataType definition
|
Attributes |
Value |
||
|
BrowseName |
2:ReserveCommunicationIdsResultDataType |
||
|
IsAbstract |
True |
||
|
References |
Node Class |
BrowseName |
Description |
|
Subtype of the 0:Structure defined in OPC 10000-5 |
|||
|
HasSubtype |
DataType |
2:PubSubReserveCommunicationIdsResultDataType |
Defined in 10.40.3 |
|
ConformanceUnits |
|||
|
UAFX AutomationComponent Base |
|||
|
UAFX ConnectionManager Base |
|||
The PubSubReserveCommunicationIdsResultDataType is formally defined in Table 198.
Table 198 – PubSubReserveCommunicationIdsResultDataType structure
|
Name |
Type |
Description |
|
PubSubReserveCommunicationIdsResultDataType |
Structure |
Subtype of the ReserveCommunicationIdsResultDataType |
|
Result |
0:StatusCode |
Indicates the overall result of reserving the IDs. |
|
DefaultPublisherId |
0:BaseDataType |
Indicates the default PublisherId of the addressed Server for the requested TransportProfileUri. |
|
WriterGroupIds |
0:UInt16[] |
Indicates the reserved IDs for WriterGroups for the requested TransportProfileUri. |
|
DataSetWriterIds |
0:UInt16[] |
Indicates the reserved IDs for DataSetWriters for the requested TransportProfileUri. |
The PubSubReserveCommunicationIdsResultDataType representation in the AddressSpace is formally defined in Table 199.
Table 199 – PubSubReserveCommunicationIdsResultDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
2:PubSubReserveCommunicationIdsResultDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 2:ReserveCommunicationIdsResultDataType |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX ConnectionManager Base |
||||||
This data type will be specified in a later version of this document.
This structure DataType holds the configuration information for a SecurityKeyServerAddressType Variable (see 9.3).
The SecurityKeyServerAddressDataType is formally defined in Table 200.
Table 200 – SecurityKeyServerAddressDataType structure
|
Name |
Type |
Description |
|
SecurityKeyServerAddressDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
Address |
0:UriString |
Specifies the security key server’s address as DiscoveryUrl in the form “scheme://hostname[:port][/path]” as defined in OPC 10000-12. |
|
SecurityPolicyUri |
0:String |
A string that contains the security policy to use when establishing the secure communication. |
|
ServerUri |
0:UriString |
The ApplicationUri of the SKS |
|
UsePushModel |
0:Boolean |
If TRUE, use the SKS push model. If FALSE, use the SKS pull model. For the SKS model, see OPC 10000-14. |
The SecurityKeyServerAddressDataType representation in the AddressSpace is formally defined in Table 201.
Table 201 – SecurityKeyServerAddressDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
4:SecurityKeyServerAddressDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX ConnectionManager Base |
||||||
This structure DataType holds the configuration information for a ServerAddressType Variable (see 9.2).
The ServerAddressDataType is formally defined in Table 202.
Table 202 – ServerAddressDataType structure
|
Name |
Type |
Description |
|
ServerAddressDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
Address |
0:UriString |
Specifies the server’s address as DiscoveryUrl in the form “scheme://hostname[:port][/path]” as defined in OPC 10000-12. |
|
SecurityMode |
0:MessageSecurityMode |
SecurityMode is the MessageSecurityMode to be used for establishing a secure communication to the Address. |
|
SecurityPolicyUri |
0:String |
SecurityPolicyUri is a string that contains the security policy to use when establishing the secure communication. |
|
ServerUri |
0:UriString |
The ApplicationUri of the Server that is being addressed, this URI may be null. |
The ServerAddressDataType representation in the AddressSpace is formally defined in Table 203.
Table 203 – ServerAddressDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
4:ServerAddressDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX ConnectionManager Base |
||||||
This enumeration is the default enumeration for the Kind Variable in the SocketType (see 6.3.6). The enumeration is formally defined in Table 204.
Table 204 – SocketKindEnum items
|
Name |
Value |
Description |
|
RJ45 |
0 |
This is an RJ45 connector |
|
M12 |
1 |
This is an M12 connector |
The SocketKindEnum representation in the AddressSpace is formally defined in Table 205.
Table 205 – SocketKindEnum definition
|
Attribute |
Value |
|||||
|
BrowseName |
3:SocketKindEnum |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Enumeration type defined in OPC 10000-5 |
||||||
|
0:HasProperty |
Variable |
0:EnumStrings |
0:LocalizedText[] |
0:PropertyType |
|
|
|
ConformanceUnits |
||||||
|
UAFX AssetConnector Socket Base |
||||||
This Structure DataType is used to describe a QoS capability.
The SubscriberQosDataType is formally defined in Table 206.
Table 206 – SubscriberQosDataType structure
|
Name |
Type |
Description |
AllowSubtypes |
|
SubscriberQosDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
|
QosCategory |
0:String |
Describes a QoS category, for example, best-effort or priority. For standard QosCategory values, see OPC 10000-14. Note that a null or empty QosCategory indicates Best Effort. |
False |
|
DatagramQos |
0:ReceiveQosDataType[] |
The DatagramQos describes QoS-related parameters. This array shall be null or empty if no QoS-related parameters are needed. For the defined parameters, see OPC 10000-14. |
True |
The SubscriberQosDataType representation in the AddressSpace is formally defined in Table 207.
Table 207 – SubscriberQosDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
3:SubscriberQosDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX AutomationComponent Base |
||||||
|
UAFX FunctionalEntity Base |
||||||