An instance of this ObjectType represents the root Object for all PubSub related configuration and metadata Objects. The one instance of this ObjectType that represents the root Object is defined in 8.3.2. The ObjectType is formally defined in Table 205.
Table 205 – PublishSubscribeType definition
Attribute |
Value |
||||
BrowseName |
PublishSubscribeType |
||||
IsAbstract |
False |
||||
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Modelling Rule |
Subtype of PubSubKeyServiceType defined in 8.2. |
|||||
|
|
|
|
|
|
HasPubSubConnection |
Object |
<ConnectionName> |
|
PubSubConnectionType |
OptionalPlaceholder |
HasComponent |
Method |
SetSecurityKeys |
Defined in 9.1.3.3. |
Optional |
|
HasComponent |
Method |
AddConnection |
Defined in 9.1.3.4. |
Optional |
|
HasComponent |
Method |
RemoveConnection |
Defined in 9.1.3.5. |
Optional |
|
HasComponent |
Object |
PublishedDataSets |
|
DataSetFolderType |
Mandatory |
HasComponent |
Object |
SubscribedDataSets |
|
SubscribedDataSetFolderType |
Optional |
HasComponent |
Object |
PubSubConfiguration |
|
PubSubConfigurationType |
Optional |
HasComponent |
Object |
Status |
|
PubSubStatusType |
Mandatory |
HasComponent |
Object |
Diagnostics |
|
PubSubDiagnosticsRootType |
Optional |
HasComponent |
Object |
PubSubCapablities |
|
PubSubCapabilitiesType |
Optional |
HasComponent |
Object |
DataSetClasses |
|
FolderType |
Optional |
HasProperty |
Variable |
SupportedTransportProfiles |
String[] |
PropertyType |
Mandatory |
HasProperty |
Variable |
DefaultDatagramPublisherId |
UInt64 |
PropertyType |
Optional |
HasProperty |
Variable |
ConfigurationVersion |
VersionTime |
PropertyType |
Optional |
HasProperty |
Variable |
DefaultSecurityKeyServices |
EndpointDescription[] |
PropertyType |
Optional |
HasProperty |
Variable |
ConfigurationProperties |
KeyValuePair [] |
PropertyType |
Optional |
Conformance Units |
|||||
PubSub Model Base |
The PublishSubscribeType ObjectType is a concrete type and can be used directly.
The configured connection Objects are added as components to the instance of the PublishSubscribeType. Connection Objects may be configured with product-specific configuration tools or added and removed through the Methods AddConnection and RemoveConnection. The PubSubConnectionType is defined in 9.1.5.2. The HasPubSubConnection ReferenceType is defined in 9.1.3.6.
The PublishedDataSets Object contains the configured PublishedDataSets. The DataSetFolderType is defined in 9.1.4.5.1. The DataSetFolderType can be used to build a tree of DataSetFolders.
The SubscribedDataSets Object contains the configured SubscribedDataSets. The SubscribedDataSetFolderType is defined in 9.1.9.4. The SubscribedDataSetFolderType can be used to build a tree of SubscribedDataSetFolders.
The PubSubConfiguration Object provides read and write access to the PubSub configuration through a PubSubConfigurationType with is a subtype of FileType. The read access is to the complete configuration. The write access allows add, modify and delete operations to the existing PubSub configuration. The PubSubConfigurationType and the related DataTypes are defined in 9.1.3.7.
The Status Object provides the current operational status of the PublishSubscribe functionality. The PubSubStatusType is defined in 9.1.10. The state machine for the status and the relation to other PubSub Objects like PubSubConnection, PubSubGroup, DataSetWriter and DataSetReader are defined in 6.2.1.
The Diagnostics Object provides the current diagnostic information for the PublishSubscribe Object. The PubSubDiagnosticsRootType is defined in 9.1.11.7.
The SupportedTransportProfiles Property provides a list of TransportProfileUris supported by the Server. The TransportProfileUris are defined in OPC 10000-7.
The default unique PublisherId is provided through the Property DefaultDatagramPublisherId. Further details for the PublisherId are defined in 6.2.7.1. The DefaultDatagramPublisherId can be used by configuration tools to assign a unique PublisherId when adding PubSubConnections with datagram transports or broker based transports. It is also used when the PublishedId is automatically assigned by the PubSub application or returned in ReserveIds.
The ConfigurationVersion represents the time of the last configuration change.
The DefaultSecurityKeyServices provide the default SecurityKeyServices used for the PubSub configuration. The value is used as default if not overwritten in the groups or DataSetReaders. The general definition for the SecurityKeyServices parameter is in 6.2.5.4.
The ConfigurationProperties is an array of DataType KeyValuePair that specifies additional properties for the PubSub configuration. The KeyValuePair type is defined in OPC 10000-5 and consists of a QualifiedName and a value of BaseDataType. The mapping of the namespace, name, and value to concrete functionality may be defined by transport protocol mappings, future versions of this document or vendor-specific extensions.
The PubSubCapabilities Objects provides the PubSub capablitiy information. The PubSubCapabilitiesType ObjectType is defined in 9.1.12.
The DataSetClasses Folder allows a Server to expose DataSetClasses supported. These DataSetClasses can be used to create PublishedDataSets. The Folder would also be used by standard information models to include standardized DataSetClasses into their namespace.
The DataSetClasses Folder references a list of Variables where the Value of a Variable represents a DataSetClass. For each Variable, the Name field of the BrowseName equals the Name in the DataSetMetaData. The Object is formally defined in Table 206.
Table 206 – PublishSubscribeType Additional Subcomponents
BrowsePath |
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Others |
DataSetClasses |
HasComponent |
Variable |
<DataSetName> |
DataSetMetaDataType |
BaseDataVariableType |
OptionalPlaceholder |