Errata exists for this version of the document.
This PublishedDataSetType is used to configure the collection of OPC UA Events.
The PublishedEventsType is formally defined in Table 110.
Table 110 – PublishedEventsType Definition
|
Attribute |
Value |
||||
|
BrowseName |
PublishedEventsType |
||||
|
IsAbstract |
False |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Modelling Rule |
|
Subtype of PublishedDataSetType defined in 9.1.4.2.1. |
|||||
|
HasProperty |
Variable |
EventNotifier |
NodeId |
PropertyType |
Mandatory |
|
HasProperty |
Variable |
SelectedFields |
SimpleAttributeOperand[] |
PropertyType |
Mandatory |
|
HasProperty |
Variable |
Filter |
ContentFilter |
PropertyType |
Mandatory |
|
HasComponent |
Method |
ModifyFieldSelection |
Defined in 9.1.4.4.2. |
Optional |
|
The PublishedEventsType ObjectType is a concrete type and can be used directly.
The EventNotifier is defined in 6.2.2.7.1.
The SelectedFields is defined in 6.2.2.7.2.
The index into the list of entries in the SelectedFields has an important role for Subscribers. It is used as handle to reference the Event field in DataSetMessages received by Subscribers. The index may change after configuration changes. Changes are indicated by the ConfigurationVersion and applications working with the index shall always check the ConfigurationVersion before using the index. If a change of the SelectedFields adds additional fields, the MinorVersion of the ConfigurationVersion shall be updated. If a change of the SelectedFields removes fields, the MajorVersion of the ConfigurationVersion shall be updated. The Property ConfigurationVersion is defined in the base ObjectType PublishedDataSetType.
The Filter is defined in 6.2.2.7.3. A change of the Filter does not affect the ConfigurationVersion since the content of the DataSet does not change.
This Method is used to modify the event field selection of a PublishedEventsType Object.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
ModifyFieldSelection (
[in]ConfigurationVersionDataType ConfigurationVersion
[in]String[] FieldNameAliases
[in]Boolean[] PromotedFields
[in]SimpleAttributeOperand[] SelectedFields
[out]ConfigurationVersionDataType NewConfigurationVersion
);
|
Argument |
Description |
|
ConfigurationVersion |
Configuration version of the DataSet. The configuration version must match the entire current configuration version of the Object when the Method call is processed. If it does not match, the result Bad_InvalidState shall be returned. The ConfigurationVersionDataType is defined in 6.2.2.1.5. |
|
FieldNameAliases |
The names assigned to the selected fields in the DataSetMetaData and in the DataSetMessages for tagged message encoding. The size and the order of the array must match the SelectedFields. The string is used to set the name field in the FieldMetaData that is part of the DataSetMetaData. |
|
PromotedFields |
The flags indicating if the corresponding field is promoted to the DataSetMessage header. The size and the order of the array shall match the SelectedFields. The flag is used to set the corresponding field in the FieldMetaData that is part of the DataSetMetaData. |
|
SelectedFields |
The selection of Event fields contained in the DataSet generated for an Event and sent through the DataSetWriter. The SimpleAttributeOperand DataType is defined in OPC 10000-4. A change to the selected fields requires a change of the ConfigurationVersion. |
|
NewConfigurationVersion |
Return the new configuration version of the DataSet. |
Method Result Codes
|
ResultCode |
Description |
|
Bad_InvalidState |
The configuration version did not match the current state of the Object. |
|
Bad_EventFilterInvalid |
The event filter is not valid. |
|
Bad_UserAccessDenied |