9.1.10 PubSub Status Object

9.1.10.1 PubSubStatusType

This ObjectType is used to indicate and change the status of a PubSub Object like PubSubConnection, DataSetWriter or DataSetReader. The PubSubStatusType is formally defined in Table 307.

Table 307 – PubSubStatusType definition
Attribute Value
BrowseNamePubSubStatusType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of BaseObjectType defined in OPC 10000-5.
HasComponentVariableStatePubSubStateBaseDataVariableTypeMandatory
HasComponentMethodEnableDefined in 9.1.10.2.Optional
HasComponentMethodDisableDefined in 9.1.10.3.Optional
Conformance Units
PubSub Model Base

The State Variable provides the current operational state of the PubSub Object. The default value is Disabled. The PubSubState Enumeration and the related state machine are defined in 6.2.1.

The State may be changed with product-specific configuration tools or with the Methods Enable and Disable.

9.1.10.2 Enable Method

This Method is used to enable a configured PubSub Object. The related state machine and the transitions triggered by a successful call to this Method are defined in 6.2.1.

The Server shall reject Enable Method calls if the current State is not Disabled.

The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.

Signature

	Enable ();

Method Result Codes

ResultCode Description
Bad_InvalidStateThe state of the Object is not disabled.
Bad_UserAccessDeniedThe Session user is not allowed to configure the Object.

Table 308 specifies the AddressSpace representation for the Enable Method.

Table 308 – Enable Method AddressSpace definition
Attribute Value
BrowseNameEnable
ConformanceUnits
PubSub Model Base
9.1.10.3 Disable Method

This Method is used to disable a PubSub Object. The related state machine and the transitions triggered by a successful call to this Method are defined in 6.2.1.

The Server shall reject Disable Method calls if the current State is Disabled.

The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.

Signature

	Disable ();

Method Result Codes

ResultCode Description
Bad_InvalidStateThe state of the Object is not operational.
Bad_UserAccessDeniedThe Session user is not allowed to configure the Object.

Table 309 specifies the AddressSpace representation for the Disable Method.

Table 309 – Disable Method AddressSpace definition
Attribute Value
BrowseNameDisable
ConformanceUnits
PubSub Model Base
9.1.10.4 Status Object

PubSub ObjectTypes that require a status Object add a component with the BrowseName Status.