9.1.9.4 Subscribed DataSet Folder
9.1.9.4.1 SubscribedDataSetFolderType
The SubscribedDataSetFolderType is formally defined in Table 301.
| Attribute | Value | ||||
| BrowseName | SubscribedDataSetFolderType | ||||
| IsAbstract | False | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| Subtype of FolderType defined in OPC 10000-5. | |||||
| Organizes | Object | <SubscribedDataSetFolderName> | SubscribedDataSetFolderType | OptionalPlaceholder | |
| HasComponent | Object | <StandaloneSubscribedDataSetName> | StandaloneSubscribedDataSetType | OptionalPlaceholder | |
| HasComponent | Method | AddSubscribedDataSet | Defined in 9.1.9.4.2 | Optional | |
| HasComponent | Method | RemoveSubscribedDataSet | Defined in 9.1.9.4.3 | Optional | |
| HasComponent | Method | AddDataSetFolder | Defined in 9.1.9.4.4. | Optional | |
| HasComponent | Method | RemoveDataSetFolder | Defined in 9.1.9.4.5. | Optional | |
| Conformance Units | |||||
| PubSub Model SubscribedDataSet Standalone | |||||
The SubscribedDataSetFolderType ObjectType is a concrete type and can be used directly.
Instances of the SubscribedDataSetFolderType can contain StandaloneSubscribedDataSets or other instances of the SubscribedDataSetFolderType. This can be used to build a tree of Folder Objects used to group the configured StandaloneSubscribedDataSets.
The StandaloneSubscribedDataSetType Objects are added as components to the instance of the SubscribedDataSetFolderType. An instance of a StandaloneSubscribedDataSetType is referenced only from one SubscribedDataSetFolder. If the SubscribedDataSetFolder is deleted, all referenced StandaloneSubscribedDataSetType Objects are deleted with the folder.
StandaloneSubscribedDataSetType Objects may be configured with product-specific configuration tools or added and removed through the Methods AddSubscribedDataSet and RemoveSubscribedDataSet.
9.1.9.4.2 AddSubscribedDataSet Method
This Method is used to add a new standalone subscribed DataSet Object to an instance of the DataSet Folder.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
AddSubscribedDataSet (
[in] StandaloneSubscribedDataSetDataType SubscribedDataSet,
[out] NodeId SubscribedDataSetNodeId
);
| Argument | Description |
| SubscribedDataSet | The standalone subscribed DataSet to add. |
| SubscribedDataSetNodeId | The NodeId of the new standalone subscribed DataSet Object. |
Method Result Codes
| ResultCode | Description |
| Bad_InvalidArgument | The Server is not able to apply the name. The name may be too long or may contain invalid characters. |
| Bad_BrowseNameDuplicated | An Object with the name already exists in the folder. |
| Bad_ResourceUnavailable | The Server does not have enough resources to add the subscribed DataSet. |
| Bad_UserAccessDenied | The Session user does not have rights to create the subscribed DataSet. |
Table 302 specifies the AddressSpace representation for the AddSubscribedDataSet Method.
| Attribute | Value | ||||
| BrowseName | AddSubscribedDataSet | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| HasProperty | Variable | OutputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model SubscribedDataSet Standalone |
9.1.9.4.3 RemoveSubscribedDataSet Method
This Method is used to remove a standalone subscribed DataSet Object from a subscribed DataSet Folder. If a DataSetReader is connected, the DataSetReader is removed too.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
RemoveSubscribedDataSet (
[in] NodeId SubscribedDataSetNodeId
);
| Argument | Description |
| SubscribedDataSetNodeId | NodeId of the standalone subscribed DataSet to remove from the folder. |
Method Result Codes
| ResultCode | Description |
| Bad_NodeIdUnknown | The SubscribedDataSetNodeId is unknown. |
| Bad_NodeIdInvalid | The SubscribedDataSetNodeId is not a NodeId of a standalone subscribed DataSet. |
| Bad_UserAccessDenied | The Session user does not have rights to delete the Object. |
Table 303 specifies the AddressSpace representation for the RemoveSubscribedDataSet Method.
| Attribute | Value | ||||
| BrowseName | RemoveSubscribedDataSet | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model SubscribedDataSet Standalone |
9.1.9.4.4 AddDataSetFolder Method
This Method is used to add a SubscribedDataSetFolderType Object to a SubscribedDataSetFolderType Object.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
AddDataSetFolder (
[in] String Name,
[out] NodeId DataSetFolderNodeId
);
| Argument | Description |
| Name | Name of the Object to create. |
| DataSetFolderNodeId | NodeId of the created SubscribedDataSetFolderType Object. |
Method Result Codes
| ResultCode | Description |
| Bad_BrowseNameDuplicated | A folder Object with the name already exists. |
| Bad_InvalidArgument | The Server is not able to apply the Name. The Name may be too long or may contain invalid characters. |
| Bad_UserAccessDenied | The Session user is not allowed to add a folder. |
Table 304 specifies the AddressSpace representation for the AddDataSetFolder Method.
| Attribute | Value | ||||
| BrowseName | AddDataSetFolder | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| HasProperty | Variable | OutputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model SubscribedDataSet Standalone |
9.1.9.4.5 RemoveDataSetFolder Method
This Method is used to remove a SubscribedDataSetFolderType Object from the parent SubscribedDataSetFolderType Object.
A successful removal of the SubscribedDataSetFolderType Object removes all associated StandaloneSubscribedDataSetType Objects and their associated DataSetReader Objects. Before the Objects are removed, their state is changed to Disabled.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
RemoveDataSetFolder (
[in] NodeId DataSetFolderNodeId
);
| Argument | Description |
| DataSetFolderNodeId | NodeId of the SubscribedDataSetFolderType Object to remove from the Server. |
Method Result Codes
| ResultCode | Description |
| Bad_NodeIdUnknown | The DataSetFolderNodeId is unknown. |
| Bad_UserAccessDenied | The Session user is not allowed to delete the folder. |
Table 305 specifies the AddressSpace representation for the RemoveDataSetFolder Method.
| Attribute | Value | ||||
| BrowseName | RemoveDataSetFolder | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model SubscribedDataSet Standalone |