C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
UaContentFilter Class Reference

OPC UA ContentFilter used in event filters and the Query service. More...

#include <uacontentfilter.h>

Public Member Functions

 UaContentFilter ()
 Constructs an empty content filter object.
 
 UaContentFilter (const UaContentFilter &other)
 Constructs a content filter object from another content filter object.
 
 UaContentFilter (const OpcUa_ContentFilter &other)
 Constructs a content filter object from a content filter structure.
 
 ~UaContentFilter ()
 Destroys the content filter object.
 
UaContentFilteroperator= (const UaContentFilter &other)
 Assigns another content filter object to this content filter object and returns a reference to this object.
 
UaStatus setContentFilter (const OpcUa_ContentFilter *pContentFilter, OpcUa_EventFilterResult *pEventFilterResult, OpcUa_Boolean &hasFilterError)
 Creates the content filter class data with all child objects from the passed OpcUa_ContentFilter structure. More...
 
void setContentFilterElement (OpcUa_UInt32 index, UaContentFilterElement *pElement, OpcUa_UInt32 arraySize)
 Sets one of the elements of the content filter. More...
 
OpcUa_UInt32 getContentFilterElementArraySize () const
 Returns the array size of the content filter element list.
 
const UaContentFilterElementgetContentFilterElement (OpcUa_UInt32 index) const
 Returns the entry from the content filter element list on the requested index. More...
 
void copyTo (OpcUa_ContentFilter &contentFilter) const
 Copies the content filter data to a OpcUa_ContentFilter structure. More...
 

Detailed Description

OPC UA ContentFilter used in event filters and the Query service.

This class is used to build and hold an OPC UA ContentFilter used in the event filter of event monitored items and as filter parameter for the Query service.

Member Function Documentation

void UaContentFilter::copyTo ( OpcUa_ContentFilter contentFilter) const

Copies the content filter data to a OpcUa_ContentFilter structure.

Parameters
[in,out]contentFilterContent filter structure to copy the content filter to
const UaContentFilterElement * UaContentFilter::getContentFilterElement ( OpcUa_UInt32  index) const

Returns the entry from the content filter element list on the requested index.

Returns
Pointer to the UaContentFilterElement.
Parameters
[in]indexIndex of the content filter element in the array
UaStatus UaContentFilter::setContentFilter ( const OpcUa_ContentFilter pContentFilter,
OpcUa_EventFilterResult pEventFilterResult,
OpcUa_Boolean &  hasFilterError 
)

Creates the content filter class data with all child objects from the passed OpcUa_ContentFilter structure.

This method is only used on the server side to create the content filter tree and to verify the filter.

Returns
Status code.
Parameters
[in]pContentFilterA pointer set to the filter
[in,out]pEventFilterResultThe result of the filter operation
[in,out]hasFilterErrorIndicates if errors occured in the filter operation.
void UaContentFilter::setContentFilterElement ( OpcUa_UInt32  index,
UaContentFilterElement pElement,
OpcUa_UInt32  arraySize 
)

Sets one of the elements of the content filter.

The class takes the ownership of the passed object pElement.

Parameters
[in]indexIndex of the content filter element in the array
[in]pElementUaContentFilterElement to set at the index in the array
[in]arraySizeSize of the content filter element array filled with this method

The documentation for this class was generated from the following files: