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.

Figure 61 – ReserveCommunicationIdsResultDataType illustration

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.

Table 215 – ReserveCommunicationIdsResultDataType definition
Attributes Value
BrowseName2:ReserveCommunicationIdsResultDataType
IsAbstractTrue
References Node Class BrowseName Description
Subtype of the 0:Structure defined in OPC 10000-5
HasSubtypeDataType2:PubSubReserveCommunicationIdsResultDataTypeDefined in 10.44.3
ConformanceUnits
UAFX AutomationComponent Base
UAFX ConnectionManager Base

10.44.3 PubSubReserveCommunicationIdsResultDataType

The PubSubReserveCommunicationIdsResultDataType is formally defined in Table 216.

Table 216 – PubSubReserveCommunicationIdsResultDataType structure
NameTypeDescription
PubSubReserveCommunicationIdsResultDataTypeStructureSubtype of the ReserveCommunicationIdsResultDataType
Result0:StatusCodeIndicates the overall result of reserving the IDs.
DefaultPublisherId0:BaseDataTypeIndicates the default PublisherId of the addressed Server for the requested TransportProfileUri.
WriterGroupIds0:UInt16[]Indicates the reserved IDs for WriterGroups for the requested TransportProfileUri.
DataSetWriterIds0:UInt16[]Indicates the reserved IDs for DataSetWriters for the requested TransportProfileUri.

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

Table 217 – PubSubReserveCommunicationIdsResultDataType definition
Attribute Value
BrowseName2:PubSubReserveCommunicationIdsResultDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the 2:ReserveCommunicationIdsResultDataType
ConformanceUnits
UAFX AutomationComponent PubSub Connections
UAFX ConnectionManager PubSubCommunicationFlowConfiguration

10.44.4 PubSubReserveCommunicationIdsResult2DataType

The PubSubReserveCommunicationIdsResult2DataType is formally defined in Table 218.

Table 218 – PubSubReserveCommunicationIdsResult2DataType structure
NameTypeDescription
PubSubReserveCommunicationIdsResult2DataTypeStructureSubtype of the PubSubReserveCommunicationIdsResultDataType.
TransportSpecificInfo0:BaseDataType

Transport-profile-specific information needed by the ConnectionManager to create a valid PubSubConfiguration for an AutomationComponent.

If transport-specific information was requested for UDP-UADP, this field shall contain the UDP port number used by the addressed AutomationComponent for receiving UDP unicast traffic, encoded as UInt16.

If transport-specific information was not requested, or if AutomationComponent has no transport-specific info for the given TransportProfileUri, this field shall be set to NULL.

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

Table 219 – PubSubReserveCommunicationIdsResult2DataType definition
Attribute Value
BrowseName2:PubSubReserveCommunicationIdsResult2DataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the 2:PubSubReserveCommunicationIdsResultDataType
ConformanceUnits
UAFX AutomationComponent PubSub Connections
UAFX ConnectionManager PubSubCommunicationFlowConfiguration

10.44.5 ClientServerReserveCommunicationIdsResultDataType

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