Figure 43depicts the ObjectTypefor the PubSubgroup model and its components and the relations to other parts of the model.

image046.png

Figure 43– PubSubGroupType overview

This ObjectTypeis the abstract base type for Objectsrepresenting communication groupingsforPubSub connections. The PubSubGroupTypeis formally defined in Table 235.

Table 235– PubSubGroupType definition

Attribute

Value

BrowseName

PubSubGroupType

IsAbstract

True

References

Node Class

BrowseName

DataType

TypeDefinition

Modelling Rule

Subtype of BaseObjectType defined in OPC 10000-5.

HasProperty

Variable

SecurityMode

MessageSecurityMode

PropertyType

Mandatory

HasProperty

Variable

SecurityGroupId

String

PropertyType

Optional

HasProperty

Variable

SecurityKeyServices

EndpointDescription[]

PropertyType

Optional

HasProperty

Variable

MaxNetworkMessageSize

UInt32

PropertyType

Mandatory

HasProperty

Variable

GroupProperties

KeyValuePair[]

PropertyType

Mandatory

HasComponent

Object

Status

PubSubStatusType

Mandatory

Conformance Units

PubSub Model Base

The SecurityModeis defined in 6.2.5.2.

The SecurityGroupIdis defined in 6.2.5.3. If the SecurityModeis not NONE, the Propertyshall provide the SecurityGroupId. The value of the Propertyis null or the Propertyis not present if the SecurityModeis NONE.

The SecurityKeyServicesparameter is defined in 6.2.5.4. If the SecurityModeis not NONE, the Propertyshall provide the list of Security Key Servicesfor the SecurityGroupId.

The MaxNetworkMessageSizeis defined in 0.

The GroupPropertiesis defined in 6.2.5.6.

The Status Objectprovides the current operational status of the group. The PubSubStatusTypeis defined in 9.1.10. The state machine for the status and the relation to other PubSub Objectslike PubSubConnection, DataSetWriterand DataSetReaderare defined in 6.2.1.

Instances of WriterGroupTypecontain settings for a group of DataSetWriters. The WriterGroupTypeis formally defined in Table 236.

Table 236– WriterGroupType definition

Attribute

Value

BrowseName

WriterGroupType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of PubSubGroupType defined in 9.1.6.2

HasProperty

Variable

WriterGroupId

UInt16

PropertyType

Mandatory

HasProperty

Variable

PublishingInterval

Duration

PropertyType

Mandatory

HasProperty

Variable

KeepAliveTime

Duration

PropertyType

Mandatory

HasProperty

Variable

Priority

Byte

PropertyType

Mandatory

HasProperty

Variable

LocaleIds

LocaleId[]

PropertyType

Mandatory

HasProperty

Variable

HeaderLayoutUri

String

PropertyType

Mandatory

HasComponent

Object

TransportSettings

WriterGroupTransportType

Optional

HasComponent

Object

MessageSettings

WriterGroupMessageType

Optional

HasDataSetWriter

Object

<DataSetWriterName>

DataSetWriterType

OptionalPlaceholder

HasComponent

Object

Diagnostics

PubSubDiagnostics‌WriterGroupType

Optional

HasComponent

Method

AddDataSetWriter

Defined in 9.1.6.4.

Optional

HasComponent

Method

RemoveDataSetWriter

Defined in 9.1.6.5.

Optional

Conformance Units

PubSub Model Base

The WriterGroupIdis defined in 6.2.6.1.

The PublishingIntervalis defined in 6.2.6.2.

The KeepAliveTimeis defined in 6.2.6.3.

The Priorityis defined in 6.2.6.4.

The LocaleIdsparameter is defined in 6.2.6.5.

The HeaderLayoutUriis defined in 6.2.6.6.

The transport protocol mapping specific setting settings are provided in the optional Object TransportSettings. The WriterGroupTransportTypeis defined in 9.1.6.7. The Objectshall be present if the transport protocol mapping requires specific settings.

The message mapping specific setting settings are provided in the optional Object MessageSettings. The WriterGroupMessageTypeis defined in 9.1.6.8. The Objectshall be present if the message mapping defines specific parameters.

The configured DataSetWriterType Objectsare added as components to the instance of the group. DataSetWriterType Objectsmay be configured with product-specific configuration tools or through OPC UA Methods AddDataSetWriterand RemoveDataSetWriter. The DataSetWriterTypeis defined in 9.1.7.1. The ReferenceType HasDataSetWriteris defined in 9.1.6.6.

The Diagnostics Object provides the current diagnostic information for a WriterGroupType Object. The PubSubDiagnosticsWriterGroupTypeis defined in 9.1.11.9.

This Methodis used to add a new DataSetWriterType Objectto an instance of the WriterGroup. A successful creation of the DataSetWritershall also create a Referencefrom the related PublishedDataSet Objectto the created DataSetWriter.

The Clientshall be authorized to modify the configuration for the PubSubfunctionality when invoking this Methodon the Server.

Signature

AddDataSetWriter(

[in]DataSetWriterDataType Configuration,

[out]NodeId DataSetWriterNodeId

);

Argument

Description

Configuration

Configuration parameters for the DataSetWriter. The parameters and the DataSetWriterDataTypeare defined in 6.2.4.

DataSetWriterNodeId

The NodeIdof the new DataSetWriter Object.

Method Result Codes

ResultCode

Description

Bad_InvalidArgument

The Serveris not able to apply the name. The name may be too long or may contain invalid characters.

Bad_DataSetIdInvalid

The DataSetspecified for the DataSetWritercreation is invalid.

Bad_BrowseNameDuplicated

An Objectwith the name already exists in the group.

Bad_ResourceUnavailable

The Serverhas not enough resources to add the DataSetWriter.

Bad_UserAccessDenied

The Sessionuser does not have rights to create the DataSetWriter.

Table 237specifies the AddressSpacerepresentation for the AddDataSetWriter Method.

Table 237– AddDataSetWriter Method AddressSpace definition

Attribute

Value

BrowseName

AddDataSetWriter

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

HasProperty

Variable

InputArguments

Argument[]

PropertyType

Mandatory

HasProperty

Variable

OutputArguments

Argument[]

PropertyType

Mandatory

ConformanceUnits

PubSub Model Base

This Methodis used to remove a DataSetWriter Objectfrom the group. The state of the DataSetWriteris set to Disabledbefore removing the Object. A successful removal of the DataSetWritershall also delete the Referencefrom the related PublishedDataSetType Objectto the removed DataSetWriter.

The Clientshall be authorized to modify the configuration for the PubSubfunctionality when invoking this Methodon the Server.

Signature

RemoveDataSetWriter(

[in]NodeIdDataSetWriterNodeId

);

Argument

Description

DataSetWriterNodeId

NodeIdof the DataSetWriter to remove from the group.

Method Result Codes

ResultCode

Description

Bad_NodeIdUnknown

The DataSetWriterNodeIdis unknown.

Bad_NodeIdInvalid

The DataSetWriterNodeIdis not a NodeIdof a DataSetWriter.

Bad_UserAccessDenied

The Sessionuser is not allowed to delete a DataSetWriter.

Table 238specifies the AddressSpacerepresentation for the RemoveDataSetWriter Method.

Table 238– RemoveDataSetWriter Method AddressSpace definition

Attribute

Value

BrowseName

RemoveDataSetWriter

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

HasProperty

Variable

InputArguments

Argument[]

PropertyType

Mandatory

ConformanceUnits

PubSub Model Base

The HasDataSetWriter ReferenceTypeis a concrete ReferenceTypethat can be used directly. It is a subtype of the HasComponent ReferenceType.

The SourceNodeof Referencesof this type shall be an instance of the WriterGroupTypedefined in 9.1.6.3.

The TargetNodeof this ReferenceType shall be an instance of the DataSetWriterTypedefined in 9.1.7.1.

Serversshall provide the inverse Referencethat relates a DataSetWriter Objectback to a WriterGroupTypeObject.

The representation of the HasDataSetWriter ReferenceTypein the AddressSpaceis specified in Table 239.

Table 239– HasDataSetWriter ReferenceType

Attributes

Value

BrowseName

HasDataSetWriter

InverseName

IsWriterInGroup

Symmetric

False

IsAbstract

False

References

NodeClass

BrowseName

Comment

Subtype of HasComponent defined in OPC 10000-5.

Conformance Units

PubSub Model Base

This ObjectTypeis the abstract base type for Objectsrepresenting transport protocol mapping specific settingsforWriterGroups. The WriterGroupTransportTypeis formally defined in Table 240.

Table 240– WriterGroupTransportType definition

Attribute

Value

BrowseName

WriterGroupTransportType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of BaseObjectType

Conformance Units

PubSub Model Base

This ObjectTypeis the abstract base type for Objectsrepresenting message mapping specific settingsforWriterGroups. The WriterGroupMessageTypeis formally defined in Table 241.

Table 241– WriterGroupMessageType definition

Attribute

Value

BrowseName

WriterGroupMessageType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of BaseObjectType

Conformance Units

PubSub Model Base

This ObjectTypeis a concrete type for Objectsrepresenting DataSetReadergroupingsforPubSub connections. The ReaderGroupTypeis formally defined in Table 242.

Table 242– ReaderGroupType definition

Attribute

Value

BrowseName

ReaderGroupType

IsAbstract

False

References

Node Class

BrowseName

Data Type

TypeDefinition

ModellingRule

Subtype of PubSubGroupType defined in 9.1.6.2

HasDataSetReader

Object

<DataSetReaderName>

DataSetReaderType

OptionalPlaceholder

HasComponent

Object

Diagnostics

PubSubDiagnostics‌ReaderGroupType

Optional

HasComponent

Object

TransportSettings

ReaderGroupTransportType

Optional

HasComponent

Object

MessageSettings

ReaderGroupMessageType

Optional

HasComponent

Method

AddDataSetReader

Defined in 9.1.6.10.

Optional

HasComponent

Method

RemoveDataSetReader

Defined in 9.1.6.11.

Optional

Conformance Units

PubSub Model Base

The configured DataSetReaderType Objectsare added as components to the instance of the group. DataSetReaderType Objectsmay be configured with product-specific configuration tools or through OPC UA Methods AddDataSetReaderand RemoveDataSetReader. The DataSetReaderTypeis defined in 9.1.8.1. The ReferenceType HasDataSetReaderis defined in 9.1.6.12.

The Diagnostics Object provides the current diagnostic information for a ReaderGroupType Object. The PubSubDiagnosticsReaderGroupTypeis defined in 9.1.11.10.

The transport protocol mapping specific setting settings are provided in the optional Object TransportSettings. The ReaderGroupTransportTypeis defined in 9.1.6.13. The Objectshall be present if the transport protocol mapping defines specific parameters.

The message mapping specific setting settings are provided in the optional Object MessageSettings. The ReaderGroupMessageTypeis defined in 9.1.6.14. The Objectshall be present if the message mapping defines specific parameters.

This Methodis used to add a new DataSetReaderType Objectto an instance of the ReaderGroup.

The Clientshall be authorized to modify the configuration for the PubSubfunctionality when invoking this Methodon the Server.

Signature

AddDataSetReader(

[in]DataSetReaderDataType Configuration,

[out]NodeId DataSetReaderNodeId

);

Argument

Description

Configuration

Configuration parameters for the DataSetWriter. The parameters and the DataSetReaderDataTypeare defined in 6.2.9.

DataSetReaderNodeId

The NodeIdof the new DataSetReaderObject.

Method Result Codes

ResultCode

Description

Bad_InvalidArgument

The Serveris not able to apply the name. The name may be too long or may contain invalid characters.

Bad_BrowseNameDuplicated

An Objectwith the name already exists in the group.

Bad_ResourceUnavailable

The Serverdoes not have enough resources to add the DataSetReader.

Bad_UserAccessDenied

The Sessionuser does not have rights to create the DataSetReader.

Table 243specifies the AddressSpacerepresentation for the AddDataSetReader Method.

Table 243– AddDataSetReader Method AddressSpace definition

Attribute

Value

BrowseName

AddDataSetReader

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

HasProperty

Variable

InputArguments

Argument[]

PropertyType

Mandatory

HasProperty

Variable

OutputArguments

Argument[]

PropertyType

Mandatory

ConformanceUnits

PubSub Model Base

This Methodis used to remove a DataSetReader Objectfrom the group. The state of the DataSetReaderis set to Disabledbefore the Objectis removed.

The Clientshall be authorized to modify the configuration for the PubSubfunctionality when invoking this Methodon the Server.

Signature

RemoveDataSetReader(

[in]NodeIdDataSetReaderNodeId

);

Argument

Description

DataSetReaderNodeId

NodeIdof the DataSetReaderto remove from the group.

Method Result Codes

ResultCode

Description

Bad_NodeIdUnknown

The DataSetReaderNodeIdis unknown.

Bad_NodeIdInvalid

The DataSetReaderNodeIdis not a NodeId of a DataSetReader.

Bad_UserAccessDenied

The Sessionuser does not have rights to delete the DataSetReader.

Table 244specifies the AddressSpacerepresentation for the RemoveDataSetReader Method.

Table 244– RemoveDataSetReader Method AddressSpace definition

Attribute

Value

BrowseName

RemoveDataSetReader

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

HasProperty

Variable

InputArguments

Argument[]

PropertyType

Mandatory

ConformanceUnits

PubSub Model Base

The HasDataSetReader ReferenceTypeis a concrete ReferenceTypethat can be used directly. It is a subtype of the HasComponent ReferenceType.

The SourceNodeof Referencesof this type shall be an instance of the ReaderGroupTypedefined in 9.1.6.6.

The TargetNodeof this ReferenceType shall be an instance of the DataSetReaderTypedefined in 9.1.8.1.

Serversshall provide the inverse Referencethat relates a DataSetReader Objectback to a ReaderGroupTypeObject.

The representation of the HasDataSetReader ReferenceTypein the AddressSpaceis specified in Table 245.

Table 245– HasDataSetReader ReferenceType

Attributes

Value

BrowseName

HasDataSetReader

InverseName

IsReaderInGroup

Symmetric

False

IsAbstract

False

References

NodeClass

BrowseName

Comment

Subtype of HasComponent defined in OPC 10000-5.

Conformance Units

PubSub Model Base

This ObjectTypeis the abstract base type for Objectsrepresenting transport protocol mapping specific settingsforReaderGroups. The ReaderGroupTransportTypeis formally defined in Table 246.

There is currently no transport protocol mapping specific setting defined.

Table 246– ReaderGroupTransportType definition

Attribute

Value

BrowseName

ReaderGroupTransportType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of BaseObjectType

Conformance Units

PubSub Model Base

This ObjectTypeis the abstract base type for Objectsrepresenting message mapping specific settingsforReaderGroups. The ReaderGroupMessageTypeis formally defined in Table 247.

There is currently no message mapping specific setting defined.

Table 247– ReaderGroupMessageType definition

Attribute

Value

BrowseName

ReaderGroupMessageType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of BaseObjectType

Conformance Units

PubSub Model Base