The DataSetFolderType is formally defined Table 111.
Table 111– DataSetFolderType Definition
|
Attribute |
Value |
||||
|
BrowseName |
DataSetFolderType |
||||
|
IsAbstract |
False |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Modelling Rule |
|
Subtype of FolderType defined in OPC 10000-5. |
|||||
|
|
|
|
|
|
|
|
Organizes |
Object |
<DataSetFolderName> |
|
DataSetFolderType |
OptionalPlaceholder |
|
HasComponent |
Object |
<PublishedDataSetName> |
|
PublishedDataSetType |
OptionalPlaceholder |
|
HasComponent |
Method |
AddPublishedDataItems |
Defined in 9.1.4.5.2. |
Optional |
|
|
HasComponent |
Method |
AddPublishedEvents |
Defined in 9.1.4.5.3. |
Optional |
|
|
HasComponent |
Method |
AddPublishedDataItemsTemplate |
Defined in 9.1.4.5.4. |
Optional |
|
|
HasComponent |
Method |
AddPublishedEventsTemplate |
Defined in 9.1.4.5.5. |
Optional |
|
|
HasComponent |
Method |
RemovePublishedDataSet |
Defined in 9.1.4.5.6. |
Optional |
|
|
HasComponent |
Method |
AddDataSetFolder |
Defined in 9.1.4.5.7. |
Optional |
|
|
HasComponent |
Method |
RemoveDataSetFolder |
Defined in 9.1.4.5.8. |
Optional |
|
The DataSetFolderType ObjectTypeis a concrete type and can be used directly.
Instances of the DataSetFolderTypecan contain PublishedDataSetsor other instances of the DataSetFolderType. This can be used to build a tree of Folder Objectsused to group the configured PublishedDataSets.
The PublishedDataSetType Objectsare added as components to the instance of the DataSetFolderType. An instance of a PublishedDataSetTypeis referenced only from one DataSetFolder. If the DataSetFolderis deleted, all referenced PublishedDataSetType Objectsare deleted with the folder.
PublishedDataSetType Objectsmay be configured with product specific configuration tools or added and removed through the Methods AddPublishedDataItems, AddPublishedEventsand RemovePublishedDataSet. The PublishedDataSetType is defined in 9.1.4.2.1.
This Methodis used to create a PublishedDataSets Objectof type PublishedDataItemsType and to add it to the DataSetFolderType Object. The configuration parameters passed in with this Methodare further described in the PublishedDataItemsTypedefined in 9.1.4.3.1and the PublishedDataSetTypedefined in 9.1.4.2.
The settings in the VariablesToAddare used to configure the data acquisition for the DataSetand are used to initialize the PublishedData Propertyof the PublishedDataItemsType.
The DataSetMetaDataof the PublishedDataSetTypeis created from meta-data of the Variablesreferenced inVariablesToAddand the settings in FieldNameAliasesand FieldFlags.
The Clientshall be authorized to modify the configuration for the PubSubfunctionality when invoking this Methodon the Server.
Signature
AddPublishedDataItems (
[in]String Name
[in]String[] FieldNameAliases
[in]DataSetFieldFlags[] FieldFlags
[in]PublishedVariableDataType[] VariablesToAdd
[out] NodeId DataSetNodeId
[out]ConfigurationVersionDataType ConfigurationVersion
[out] StatusCode[] AddResults
);
|
Argument |
Description |
|
Name |
Name of the Objectto create. |
|
FieldNameAliases |
The names assigned to the selected Variablesfor the fields in the DataSetMetaDataand in the DataSetMessagesfor tagged message encoding. The size and the order of the array shall match the VariablesToAdd. The string shall be used to set the name field in the FieldMetaDatathat is part of the DataSetMetaData. The name shall be unique in the DataSet. |
|
FieldFlags |
The field flags assigned to the selected Variables for the fields in the DataSetMetaData. The size and the order of the array shall match the VariablesToAdd. The flag is used to set the corresponding field in the FieldMetaDatathat is part of the DataSetMetaData. |
|
VariablesToAdd |
Array of Variables to add to PublishedData and the related configuration settings. Successfully added variables are appended to the end of the list of published variables configured in the PublishedData Property. Failed variables are not added to the list. The PublishedVariableDataTypeis defined in 6.2.2.6.1. |
|
DataSetNodeId |
NodeIdof the created PublishedDataSets Object. |
|
ConfigurationVersion |
Returns the initial configuration version of the DataSet. |
|
AddResults |
The result codes for the variables to add. Variables exceeding the maximum number of items in the Objectare rejected with Bad_TooManyMonitoredItems. |
Method Result Codes
|
ResultCode |
Description |
|
Bad_InvalidState |
The current state of the Objectdoes not allow a configuration change. |
|
Bad_BrowseNameDuplicated |
A data set Objectwith the name already exists. |
|
Bad_UserAccessDenied |
|
|
Bad_InvalidArgument |
The Serveris not able to apply the Name. The Namemay be too long or may contain invalid characters. |
Operation Result Codes
|
ResultCode |
Description |
|
Bad_NodeIdInvalid |
See OPC 10000-4for the description of this result code. |
|
Bad_NodeIdUnknown |
See OPC 10000-4for the description of this result code. |
|
Bad_IndexRangeInvalid |
See OPC 10000-4for the description of this result code. |
|
Bad_IndexRangeNoData |
See OPC 10000-4for the description of this result code. If the ArrayDimensionshave a fixed length that cannot change and no data exists within the range of indexes specified, Bad_IndexRangeNoData is returned in AddVariables. Otherwise if the length of the array is dynamic, the Publishershall insert this status in a DataSetif no data exists within the range. |
|
Bad_TooManyMonitoredItems |
The Serverhas reached its maximum number of items for the PublishedDataItemsType object. |
|
Bad_DuplicateName |
The passed field name alias already exists. |
This Methodis used to add a PublishedEventsType Objectto the DataSetFolderType Object. The configuration parameters passed in with this Methodare further described in the PublishedEventsTypedefined in 9.1.4.4.1and the PublishedDataSetTypedefined in 9.1.4.2.
The settings in the EventNotifier, SelectedFields andFilterare used to configure the data acquisition for the DataSetand are used to initialize the correspondingPropertiesof the PublishedEventsType.
The DataSetMetaDataof the PublishedDataSetTypeis created from meta-data of the selected Eventfields and the settings in FieldNameAliasesand FieldFlags.
The Clientshall be authorized to modify the configuration for the PubSubfunctionality when invoking this Methodon the Server.
Signature
AddPublishedEvents(
[in]String Name
[in]NodeId EventNotifier
[in]String[] FieldNameAliases
[in]DataSetFieldFlags[] FieldFlags
[in]SimpleAttributeOperand[]SelectedFields
[in]ContentFilter Filter
[out]ConfigurationVersionDataTypeConfigurationVersion
[out] NodeId DataSetNodeId
);
|
Argument |
Description |
|
Name |
Name of the DataSet Objectto create. |
|
EventNotifier |
The NodeIdof the Objectin the event notifier tree of the OPC UA Serverthat is used to collect Eventsfrom. |
|
FieldNameAliases |
The names assigned to the selected fields in the DataSetMetaDataand in the DataSetMessagesfor tagged message encoding. The size and the order of the array shall match the SelectedFields. The string is used to set the name field in the FieldMetaDatathat is part of the DataSetMetaData. |
|
FieldFlags |
The field flags assigned to the selected fields in the DataSetMetaData. The size and the order of the array shall match the SelectedFields. The flag is used to set the corresponding field in the FieldMetaDatathat is part of the DataSetMetaData. |
|
SelectedFields |
The selection of Event Fields contained in the DataSetgenerated for an Eventand sent through the DataSetWriter. The SimpleAttributeOperand DataTypeis defined in OPC 10000-4. |
|
Filter |
The filter applied to the Events. It allows the reduction of the DataSetsgenerated from Eventsthrough a filter like filtering for a certain EventType. The ContentFilter DataTypeis defined in OPC 10000-4. |
|
ConfigurationVersion |
Returns the initial configuration version of the PublishedDataSets. |
|
DataSetNodeId |
NodeIdof the created PublishedDataSets Object. |
Method Result Codes
|
ResultCode |
Description |
|
Bad_InvalidState |
The current state of the Objectdoes not allow a configuration change. |
|
Bad_NodeIdExists |
A data set Objectwith the name already exists. |
|
Bad_NodeIdUnknown |
|
|
Bad_EventFilterInvalid |
The Eventfilter is not valid. |
|
Bad_UserAccessDenied |
|
|
Bad_InvalidArgument |
The Serveris not able to apply the Name. The Namemay be too long or may contain invalid characters. |
This Methodis used to create a PublishedDataSets Objectof type PublishedDataItemsType and to add it to the DataSetFolderType Object. The configuration parameters passed in with this Methodare further described in the PublishedDataItemsTypedefined in 9.1.4.3.1and the PublishedDataSetTypedefined in 9.1.4.2.
The Clientshall be authorized to modify the configuration for the PubSubfunctionality when invoking this Methodon the Server.
Signature
AddPublishedDataItemsTemplate (
[in]String Name
[in]DataSetMetaDataType DataSetMetaData
[in]PublishedVariableDataType[] VariablesToAdd
[out] NodeId DataSetNodeId
[out] StatusCode[] AddResults
);
|
Argument |
Description |
|
Name |
Name of the Objectto create. |
|
DataSetMetaData |
The DataSetMetaDatapredefined by the caller. The initial setting shall not be changed by the Publisher. If the dataSetClassIdof the DataSetMetaDatais not null, the DataSetClassId Propertyof the PublishedDataSetTypeshall be created and initialized with the dataSetClassId value. The name of the PublishedDataSet Objectis defined by the name in the DataSetMetaData. |
|
VariablesToAdd |
Array of variable settings for the data acquisition for the fields in the DataSetMetaData. The size of the array shall match the size of the fieldsarray in the DataSetMetaData. The substituteValuein the VariablesToAddentries shall be configured. For failed variables the publishedVariablefield of entry in the resulting PublishedData Propertyshall be set to a null NodeId. If there is no Variableavailable for a field in the DataSetMetaDatathe publishedVariablefield for the entry shall be set to a null NodeId. The PublishedVariableDataTypeis defined in 6.2.2.6.1. |
|
DataSetNodeId |
NodeIdof the created PublishedDataSets Object. |
|
AddResults |
The result codes for the variables to add. |
Method Result Codes
|
ResultCode |
Description |
|
Bad_InvalidState |
The current state of the Objectdoes not allow a configuration change. |
|
Bad_BrowseNameDuplicated |
A data set Objectwith the name already exists. |
|
Bad_UserAccessDenied |
|
|
Bad_InvalidArgument |
The VariablesToAddparameter does not match the array size of the fields in the DataSetMetaDataor the configuration of the VariablesToAddcontains invalid settings. |
|
Bad_TooManyMonitoredItems |
The Objectcannot be created since the number of items in the PublishedDataSetexceeds the capabilities of the Publisher. |
Operation Result Codes
|
ResultCode |
Description |
|
Bad_NodeIdInvalid |
See OPC 10000-4for the description of this result code. |
|
Bad_NodeIdUnknown |
See OPC 10000-4for the description of this result code. |
|
Bad_IndexRangeInvalid |
See OPC 10000-4for the description of this result code. |
|
Bad_IndexRangeNoData |
See OPC 10000-4for the description of this result code. If the ArrayDimensionshave a fixed length that cannot change and no data exists within the range of indexes specified, Bad_IndexRangeNoData is returned in AddVariables. Otherwise if the length of the array is dynamic, the Publishershall insert this status in a DataSetif no data exists within the range. |
|
Bad_TooManyMonitoredItems |
The Serverhas reached its maximum number of items for the PublishedDataItemsType Object. |
|
Bad_DuplicateName |
The passed field name alias already exists. |
This Methodis used to add a PublishedEventsType Objectto the DataSetFolderType Object. The configuration parameters passed in with this Methodare further described in the PublishedEventsTypedefined in 9.1.4.4.1and the PublishedDataSetTypedefined in 9.1.4.2.
The Clientshall be authorized to modify the configuration for the PubSubfunctionality when invoking this Methodon the Server.
Signature
AddPublishedEventsTemplate(
[in]String Name
[in]DataSetMetaDataType DataSetMetaData
[in]NodeId EventNotifier
[in]SimpleAttributeOperand[]SelectedFields
[in]ContentFilter Filter
[out] NodeId DataSetNodeId
);
|
Argument |
Description |
|
Name |
Name of the Objectto create. |
|
DataSetMetaData |
The DataSetMetaDatapredefined by the caller. The initial setting shall not be changed by the Publisher. If the dataSetClassIdof the DataSetMetaDatais not null, the DataSetClassId Propertyof the PublishedDataSetTypeshall be created and initialized with the dataSetClassId value. The name of the PublishedDataSet Objectis defined by the name in the DataSetMetaData. |
|
EventNotifier |
The NodeIdof the Objectin the event notifier tree of the OPC UA Serverthat is used to collect Eventsfrom. |
|
SelectedFields |
The selection of Event Fields contained in the DataSetgenerated for an Eventand sent through the DataSetWriter. The size of the array shall match the size of the fields array in the DataSetMetaData. If there is no Eventfield available for a field in the DataSetMetaDatathe browsePathfield for the SimpleAttributeOperandentry shall be set to null. The SimpleAttributeOperand DataTypeis defined in OPC 10000-4. |
|
Filter |
The filter applied to the Events. It allows the reduction of the DataSetsgenerated from Eventsthrough a filter like filtering for a certain EventType. The ContentFilter DataTypeis defined in OPC 10000-4. |
|
DataSetNodeId |
NodeIdof the created PublishedDataSets Object. |
Method Result Codes
|
ResultCode |
Description |
|
Bad_InvalidState |
The current state of the Objectdoes not allow a configuration change. |
|
Bad_NodeIdExists |
|
|
Bad_NodeIdUnknown |
|
|
Bad_EventFilterInvalid |
The Eventfilter is not valid. |
|
Bad_UserAccessDenied |
|
|
Bad_InvalidArgument |
The Serveris not able to apply the Name. The Namemay be too long or may contain invalid characters. |
This Methodis used to remove a PublishedDataSetType Objectfrom the DataSetFolderType Object.
A successful removal of the PublishedDataSetType Objectremoves all associated DataSetWriter Objects. Before the Objectsare removed, their state is changed to Disabled_0
The Clientshall be authorized to modify the configuration for the PubSubfunctionality when invoking this Methodon the Server.
Signature
RemovePublishedDataSet(
[in]NodeIdDataSetNodeId
);
|
Argument |
Description |
|
DataSetNodeId |
NodeIdof the PublishedDataSets Objectto remove from the Server. The DataSetIdis either returned by the AddPublishedDataItemsor AddPublishedEvents Methodsor can be discovered by browsing the list of configured PublishedDataSetsin the PublishSubscribe Object. |
Method Result Codes
|
ResultCode |
Description |
|
Bad_NodeIdUnknown |
The DataSetNodeIdis unknown. |
|
Bad_UserAccessDenied |
The Sessionuser is not allowed to delete a PublishedDataSetType. |
This Methodis used to add a DataSetFolderType Objectto a DataSetFolderType Object.
The Clientshall be authorized to modify the configuration for the PubSubfunctionality when invoking this Methodon the Server.
Signature
AddDataSetFolder(
[in]StringName
[out]NodeIdDataSetFolderNodeId
);
|
Argument |
Description |
|
Name |
Name of the Objectto create. |
|
DataSetFolderNodeId |
NodeIdof the created DataSetFolderType Object. |
Method Result Codes
|
ResultCode |
Description |
|
Bad_BrowseNameDuplicated |
A folder Objectwith the name already exists. |
|
Bad_InvalidArgument |
The Serveris not able to apply the Name. The Namemay be too long or may contain invalid characters. |
|
Bad_UserAccessDenied |
The Sessionuser is not allowed to add a folder. |
This Methodis used to remove a DataSetFolderType Objectfrom the parent DataSetFolderType Object.
A successful removal of the DataSetFolderType Objectremovesall associated PublishedDataSetType Objectsand their associated DataSetWriter Objects. Before the Objectsare removed, their state is changed to Disabled_0
The Clientshall be authorized to modify the configuration for the PubSubfunctionality when invoking this Methodon the Server.
Signature
RemoveDataSetFolder(
[in]NodeIdDataSetFolderNodeId
);
|
Argument |
Description |
|
DataSetFolderNodeId |
NodeIdof the DataSetFolderType Objectto remove from the Server. |
Method Result Codes
|
ResultCode |
Description |
|
Bad_NodeIdUnknown |
The DataSetFolderNodeIdis unknown. |
|
Bad_UserAccessDenied |
The Sessionuser is not allowed to delete a data set. |