10 OPC UA FX DataTypes

10.1 AggregatedHealthDataType

This structure DataType holds the information for an AggregatedHealthType Variable (see 9.1).

The AggregatedHealthDataType is formally defined in Table 121.

The AggregatedHealthDataType representation in the AddressSpace is formally defined in Table 122.

10.2 ApplicationId

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 123.

The ApplicationId representation in the AddressSpace is formally defined in Table 124.

10.3 ApplicationIdentifierDataType

The ApplicationIdentifierDataType is used to represent identification parameters. The ApplicationIdentifierDataType is formally defined in Table 125.

The ApplicationIdentifierDataType representation in the AddressSpace is formally defined in Table 126.

10.4 AssetVerificationModeEnum

This enumeration represents the mode for Asset verification.

The enumeration is formally defined in Table 127.

The AssetVerificationModeEnum representation in the AddressSpace is formally defined in Table 128.

10.5 AssetVerificationDataType

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 129.

The AssetVerificationDataType representation in the AddressSpace is formally defined in Table 130.

10.6 AssetVerificationResultDataType

This structure contains the result of Asset verification returned by the Method Call (e.g., EstablishConnections).

The structure is formally defined in Table 131.

The AssetVerificationResultDataType representation in the AddressSpace is formally defined in Table 132.

10.7 AssetVerificationResultEnum

This enumeration represents the result of Asset verification.

The enumeration is formally defined in Table 133.

The AssetVerificationResultEnum representation in the AddressSpace is formally defined in Table 134.

10.8 ClampKindEnum

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 135.

The ClampKindEnum representation in the AddressSpace is formally defined in Table 136.

10.9 CommHealthOptionSet

This OptionSet defines flags indicating the health of the ConnectionEndpoints. The CommHealthOptionSet values are formally defined in Table 137.

Bits 3:15 are reserved for future use. The CommHealthOptionSet representation in the AddressSpace is formally defined in Table 138.

10.10 CommunicationConfigurationDataType

10.10.1 Overview

The CommunicationConfigurationDataType is an abstract structure used to provide the configuration of the communication model.

The CommunicationConfigurationDataType is illustrated in Figure 54.

10.10.2 CommunicationConfigurationDataType definition

The CommunicationConfigurationDataType is an abstract type that has no fields and is expected to be subtyped. It is formally defined in Table 139.

10.10.3 PubSubCommunicationConfigurationDataType

The PubSubCommunicationConfigurationDataType contains configuration information for the PubSub communication model. It is formally defined in Table 140.

The PubSubCommunicationConfigurationDataType representation in the AddressSpace is formally defined in Table 141.

10.10.4 ClientServerCommunicationConfigurationDataType

Provides the configuration information for the Client Server communication model.

This DataType will be specified in a future version of this document.

10.11 CommunicationConfigurationResultDataType

10.11.1 Overview

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.

10.11.2 CommunicationConfigurationResultDataType definition

The CommunicationConfigurationResultDataType is an abstract type that has no structure and is expected to be subtyped. It is formally defined in Table 142.

10.11.3 PubSubCommunicationConfigurationResultDataType

The PubSubCommunicationConfigurationResultDataType is formally defined in Table 143.

The PubSubCommunicationConfigurationResultDataType representation in the AddressSpace is formally defined in Table 144.

10.11.4 ClientServerCommunicationConfigurationResultDataType

This DataType will be specified in a future version of this document.

10.12 CommunicationFlowQosDataType

This Structure DataType is used to describe an end-to-end QoS configuration for the CommunicationFlowConfiguration.

The CommunicationFlowQosDataType is formally defined in Table 145.

The CommunicationFlowQosDataType representation in the AddressSpace is formally defined in Table 146.

10.13 CommunicationLinkConfigurationDataType

10.13.1 Overview

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 utilised communication model.

The CommunicationLinkConfigurationDataType is illustrated in Figure 56.

10.13.2 CommunicationLinkConfigurationDataType definition

The CommunicationLinkConfigurationDataType is an abstract type that has no structure and is expected to be subtyped. It is formally defined in Table 147.

10.13.3 PubSubCommunicationLinkConfigurationDataType

The PubSubCommunicationLinkConfigurationDataType is used by the EstablishConnections Method and provides the configuration of references between a ConnectionEndpoint and a DataSetReader and/or a DataSetWriter.

The PubSubCommunicationLinkConfigurationDataType is formally defined in Table 148.

The PubSubCommunicationLinkConfigurationDataType representation in the AddressSpace is formally defined in Table 149.

10.13.4 ClientServerCommunicationLinkConfigurationDataType

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.

10.14 ConnectionEndpointConfigurationDataType

This structure is semantically equivalent to the ConnectionEndpointConfigurationType as defined in 6.10.2.

The structure is formally defined in Table 150.

The ConnectionEndpointConfigurationDataType representation in the AddressSpace is formally defined in Table 151.

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.

10.15 ConnectionEndpointConfigurationResultDataType

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 152.

The ConnectionEndpointConfigurationResultDataType representation in the AddressSpace is formally defined in Table 153.

10.16 ConnectionEndpointDefinitionDataType

The ConnectionEndpointDefinitionDataType is formally defined in Table 154.

The ConnectionEndpointDefinitionDataType representation in the AddressSpace is formally defined in Table 155.

10.17 ConnectionEndpointStatusEnum

This enumeration defines the values of the Status of a ConnectionEndpointType. The enumeration is formally defined in Table 156.

The ConnectionEndpointStatusEnum representation in the AddressSpace is formally defined in Table 157.

10.18 ConnectionEndpointParameterDataType

10.18.1 Overview

The ConnectionEndpointParameterDataType is an abstract structure used by the EstablishConnections Method to provide the information for the creation of a ConnectionEndpoint. It is semantically equivalent to the ConnectionEndpointParameterType as defined in 6.12.

The ConnectionEndpointParameterDataType is illustrated in Figure 57.

10.18.2 ConnectionEndpointParameterDataType definition

The ConnectionEndpointParameterDataType is formally defined in Table 158.

The ConnectionEndpointParameterDataType representation in the AddressSpace is formally defined in Table 159.

10.18.3 PubSubConnectionEndpointParameterDataType

The PubSubConnectionEndpointParameterDataType is used by the EstablishConnections Method to create a PubSubConnectionEndpoint.

The PubSubConnectionEndpointParameterDataType is formally defined in Table 160.

The PubSubConnectionEndpointParameterDataType representation in the AddressSpace is formally defined in Table 161.

10.18.4 ClientServerConnectionEndpointParameterDataType

The ClientServerConnectionEndpointParameterDataType is used by the EstablishConnections Method to create a ClientServerConnectionEndpoint.

This DataType will be specified in a future version of this document.

10.19 ConnectionDiagnosticsDataType

This Structure provides the status of a Connection in a ConnectionConfigurationSet.

The ConnectionDiagnosticsDataType is formally defined in Table 162.

The following rules apply to updating the LastActivity and all ConnectionEndpoint-related fields (ErrorEndpoint1, etc.).

When a ConnectionManager finishes processing a ConnectionConfigurationSet, it shall set the corresponding bit in the LastActivity and clear the remaining bits to indicate the kind of processing that has just finished.

For all Connections for which all required operations were successfully finished, a ConnectionManager shall clear the Error bit in LastActivity and shall set ErrorEndpoint (1 and/or 2) to NoError and shall set EndpointStatus (1 and/or 2) to Good.

For all Connections for which not all operations required in the last processing were successfully finished, a ConnectionManager shall set the Error bit in the LastActivity.

For all Connections which were affected by any failure in the last processing, a ConnectionManager shall set the ErrorEndpoint (1 and/or 2) and EndpointStatus (1 and/or 2).

If, in the last processing, some operations related to a Connection were skipped due to a failure not directly related to this Connection, a ConnectionManager shall set the corresponding ErrorEndpoint (1 and/or 2) to ProcessingStopped and EndpointStatus (1 and/or 2) to Good.

If, in the last processing, a Connection was first successfully established but then removed due to rollback, a ConnectionManager shall set the Error bit in the LastActivity. Additionally, it shall set the corresponding ErrorEndpoint (1 and/or 2) to Rollback and EndpointStatus (1 and/or 2) to Good.

When a ConnectionManager detects an error not related to the processing of a ConnectionConfigurationSet, it can overwrite the ErrorEndpoint (1 and/or 2) and EndpointStatus (1 and/or 2) with specific error information at any time. This may include errors related to monitored ConnectionEndpoints (see FxErrorEnum RuntimeError) or errors related to the operation of a local SKS (see FxErrorEnum LocalSksKeyPushError).

The ConnectionDiagnosticsDataType representation in the AddressSpace is formally defined in Table 163.

10.20 ConnectionStateEnum

The ConnectionStateEnum provides information about the current state of the Connection, as determined by the ConnectionManager. See section 10.19 for a description of the ConnectionState. The ConnectionStateEnum values are formally defined in Table 164.

ConnectionNotEstablished can result from any of the following:

ConnectionManager has not yet established the Connection;

ConnectionManager has successfully removed the Connection;

ConnectionManager detected that one or both ConnectionEndpoints have been removed (e.g., due to ConnectionEndpoint auto-cleanup or AutomationComponent power-cycle).

ConnectionStateEnum combines the Status of all ConnectionEndpoints participating in a Connection (see 10.20).

For Connection types bidirectional, unidirectional and unidirectional with heartbeat, the value is calculated according to Figure 58.

For Connection types autonomous publisher and autonomous subscriber, the value is calculated according to Figure 59.

The ConnectionStateEnum representation in the AddressSpace is formally defined in Table 165.

10.21 DeviceHealthOptionSet

This OptionSet defines flags indicating the aggregated health of the Assets. The DeviceHealthOptionSet values are formally defined in Table 166.

Bits 4:15 are reserved for future use. The DeviceHealthOptionSet representation in the AddressSpace is formally defined in Table 167.

10.22 FunctionalEntityVerificationResultEnum

This enumeration represents the result of FunctionalEntity verification. The enumeration is formally defined in Table 168.

The FunctionalEntityVerificationResultEnum representation in the AddressSpace is formally defined in Table 169.

10.23 FxCommandMask

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 170.

Bits 9:31 are reserved for future use. The FxCommandMask representation in the AddressSpace is formally defined in Table 171.

10.24 FxEditEnum

This enumeration defines the editing behaviour for a ConnectionManager. FxEditEnum is formally defined in Table 172.

The FxEditEnum representation in the AddressSpace is formally defined in Table 173.

10.25 FxErrorEnum

This enumeration defines the summary errors that a ConnectionManager may report.

FxErrorEnum values are formally defined in Table 174.

The FxErrorEnum representation in the AddressSpace is formally defined in Table 175.

Note: The Client should be aware that this enumeration may be extended in the future.

10.26 FxProcessEnum

This enumeration defines the processing behaviour of a ConnectionManager. FxProcessEnum is formally defined in Table 176.

The representation in the AddressSpace is formally defined in Table 177.

10.27 FxTimeUnitsEnum

This enumeration describes the support units of time. The enumeration is formally defined in Table 178.

The FxTimeUnitsEnum representation in the AddressSpace is formally defined in Table 179.

10.28 FxVersion

This structure contains version information that can be assigned to any Object or Variable that needs to store version information.

The FxVersion is formally defined in Table 180.

The FxVersion representation in the AddressSpace is formally defined in Table 181.

10.29 IntervalRange

The IntervalRange is a structure used to define a range of timing intervals.

The IntervalRange is formally defined in Table 182.

IntervalRange allows specifying

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 and Max to 0.

The IntervalRange representation in the AddressSpace is formally defined in Table 183.

10.30 LastActivityMask

This OptionSet defines flags indicating the last activity taken by a ConnectionManager processing a given ConnectionConfigurationSet (and, in turn, on Connection configurations within). If the OptionSet is zero (no bits set), then no activity related to the given Connection in the given ConnectionConfigurationSet has been taken.

In this OptionSet, only one bit can be set except for the Error bit, which can be set with any of the other bits.

If the ConnectionManager supports the ProcessConnectionConfigurationSets Method, then the activities correspond to the described actions in the Method, but a ConnectionManager is not required to support the ProcessConnectionConfigurationSets Method. It could still have internal or application trigger activities that correspond to these actions.

The LastActivityMask values are formally defined in Table 184.

The Establish, EstablishEnabled, and EstablishDisabled activities include resolving parameters related to a Connection, communicating with an SKS, calling the EstablishConnections Method, or any other activity related to establishing the Connection.

The LastActivityMask representation in the AddressSpace is formally defined in Table 185.

10.31 NodeIdArray

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 186.

The NodeIdArray representation in the AddressSpace is formally defined in Table 187.

10.32 NodeIdValuePair

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 188.

The NodeIdValuePair representation in the AddressSpace is formally defined in Table 189.

10.33 NodeIdTranslationDataType

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 190.

The NodeIdTranslationDataType representation in the AddressSpace is formally defined in Table 191.

10.34 OperationalHealthOptionSet

This OptionSet defines flags indicating the health of a FunctionalEntity. The OperationalHealthOptionSet values are formally defined in Table 192.

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 193.

10.35 PortableKeyValuePair

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 194.

The PortableKeyValuePair representation in the AddressSpace is formally defined in Table 195.

10.36 PortableNodeIdentifier

The PortableNodeIdentifier is used to store an identification of 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 196.

The PortableNodeIdentifier representation in the AddressSpace is formally defined in Table 197.

10.37 PortableNodeIdentifierValuePair

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 198.

The PortableNodeIdentifierValuePair representation in the AddressSpace is formally defined in Table 199.

10.38 RelatedEndpointDataType

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 201.

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 201 .

10.39 PortableRelativePath

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 202.

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 203.

10.40 PortableRelativePathElement

This structure contains an element of the PortableRelativePath.

The PortableRelativePathElement DataType is formally defined in Table 204.

The PortableRelativePathElement representation in the AddressSpace is formally defined in Table 205.

10.41 PublisherQosDataType

This Structure DataType is used to describe a QoS capability.

The PublisherQosDataType is formally defined in Table 206.

The PublisherQosDataType representation in the AddressSpace is formally defined in Table 207.

10.42 PubSubConnectionEndpointModeEnum

This enumeration defines the possible values of the Mode of the PubSubConnectionEndpointType. The enumeration is formally defined in Table 208.

The PubSubConnectionEndpointModeEnum representation in the AddressSpace is formally defined in Table 209.

10.43 ReserveCommunicationIdsDataType

10.43.1 Overview

The ReserveCommunicationIdsDataType is an abstract structure used to request communication model-specific identifiers using the EstablishConnections Method.

The ReserveCommunicationIdsDataType is illustrated in Figure 60.

10.43.2 ReserveCommunicationIdsDataType definition

The ReserveCommunicationIdsDataType is an abstract type that has no structure and is expected to be subtyped. It is formally defined in Table 210.

10.43.3 PubSubReserveCommunicationIdsDataType

The PubSubReserveCommunicationIdsDataType is formally defined in Table 211.

The PubSubReserveCommunicationIdsDataType representation in the AddressSpace is formally defined in Table 212.

10.43.4 PubSubReserveCommunicationIds2DataType

The PubSubReserveCommunicationIds2DataType is formally defined in Table 214.

The PubSubReserveCommunicationIds2DataType representation in the AddressSpace is formally defined in Table 214.

10.43.5 ClientServerReserveCommunicationIdsDataType

This data type will be specified in a later version of this document.

10.44 ReserveCommunicationIdsResultDataType

10.44.1 Overview

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 61.

10.44.2 ReserveCommunicationIdsResultDataType definition

The ReserveCommunicationIdsResultDataType, formally defined in Table 215, is an abstract type that has no structure and is expected to be subtyped.

10.44.3 PubSubReserveCommunicationIdsResultDataType

The PubSubReserveCommunicationIdsResultDataType is formally defined in Table 216.

The PubSubReserveCommunicationIdsResultDataType representation in the AddressSpace is formally defined in Table 217.

10.44.4 PubSubReserveCommunicationIdsResult2DataType

The PubSubReserveCommunicationIdsResult2DataType is formally defined in Table 218.

The PubSubReserveCommunicationIdsResult2DataType representation in the AddressSpace is formally defined in Table 219.

10.44.5 ClientServerReserveCommunicationIdsResultDataType

This data type will be specified in a later version of this document.

10.45 SecurityKeyServerAddressDataType

This structure DataType holds the configuration information for a SecurityKeyServerAddressType Variable (see 9.3).

The SecurityKeyServerAddressDataType is formally defined in Table 220.

The SecurityKeyServerAddressDataType representation in the AddressSpace is formally defined in Table 221.

10.46 ServerAddressDataType

This structure DataType holds the configuration information for a ServerAddressType Variable (see 9.2).

The ServerAddressDataType is formally defined in Table 222.

The ServerAddressDataType representation in the AddressSpace is formally defined in Table 223.

10.47 SocketKindEnum

This enumeration is the default enumeration for the Kind Variable in the SocketType (see 6.3.6). The enumeration is formally defined in Table 224.

The SocketKindEnum representation in the AddressSpace is formally defined in Table 225.

10.48 SubscriberQosDataType

This Structure DataType is used to describe a QoS capability.

The SubscriberQosDataType is formally defined in Table 226.

The SubscriberQosDataType representation in the AddressSpace is formally defined in Table 227.