Errata exists for this version of the document.
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 132.
Table 132 – PubSubStatusType Definition
Attribute |
Value |
||||
BrowseName |
PubSubStatusType |
||||
IsAbstract |
False |
||||
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Modelling Rule |
Subtype of BaseObjectType defined in OPC 10000-5. |
|||||
HasComponent |
Variable |
State |
PubSubState |
BaseDataVariableType |
Mandatory |
HasComponent |
Method |
Enable |
Defined in 9.1.10.2. |
Optional |
|
HasComponent |
Method |
Disable |
Defined in 9.1.10.3. |
Optional |
The State Variable provides the current operational state of the PubSub Object. The default value is Disabled_0. The PubSubState Enumeration and the related state machine is defined in 6.2.1.
The State may be changed with product specific configuration tools or with the Methods Enable and Disable.
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_0.
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_InvalidState |
The state of the Object is not disabled. |
Bad_UserAccessDenied |
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_0.
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_InvalidState |
The state of the Object is not operational. |
Bad_UserAccessDenied |
PubSub ObjectTypes that require a status Object add a component with the BrowseName Status. It is formally defined in Table 133.
Table 133 – Status Object Definition
Attribute |
Value |
||||
BrowseName |
Status |
||||
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Modelling Rule |
HasTypeDefinition |
ObjectType |
PubSubStatusType |
|
|
|