UaContentFilter Class Reference

#include <uacontentfilter.h>

Collaboration diagram for UaContentFilter:

List of all members.

Public Member Functions
	UaContentFilter ()
	~UaContentFilter ()
UaStatus	setContentFilter (const OpcUa_ContentFilter *pContentFilter, OpcUa_EventFilterResult *pEventFilterResult, OpcUa_Boolean &hasFilterError)
void	setContentFilterElement (OpcUa_UInt32 index, UaContentFilterElement *pElement, OpcUa_UInt32 arraySize)
OpcUa_UInt32	getContentFilterElementArraySize () const
const UaContentFilterElement *	getContentFilterElement (OpcUa_UInt32 index) const
	< [in] Index of the content filter element in the array
void	copyTo (OpcUa_ContentFilter &contentFilter)

---

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.

---

Constructor & Destructor Documentation

UaContentFilter::UaContentFilter

(

)

Constructs an empty content filter object.

The typeId is initialized with the nodeId of the BaseEventType. The attributeId is initialized with OpcUa_Attributes_Value.

UaContentFilter::~UaContentFilter

(

)

Destroys the content filter object

---

Member Function Documentation

void UaContentFilter::copyTo

(

OpcUa_ContentFilter &

contentFilter )

Copies the content filter data to a OpcUa_ContentFilter structure

Parameters:

[in,out]

contentFilter

Content filter structure to copy the content filter to

const UaContentFilterElement * UaContentFilter::getContentFilterElement

(

OpcUa_UInt32

index )

const

< [in] Index of the content filter element in the array

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

Returns:

Pointer to the UaContentFilterElement.

OpcUa_UInt32 UaContentFilter::getContentFilterElementArraySize

(

)

const

Returns the array size of content filter element list.

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]	pContentFilter	A pointer set to the filter
[in,out]	pEventFilterResult	The result of the filter operation
[in,out]	hasFilterError	Indicates if there are errors occured in the filter operation.

void UaContentFilter::setContentFilterElement	(	OpcUa_UInt32	index,
		UaContentFilterElement *	pElement,
		OpcUa_UInt32	arraySize
	)

Sets one of content filter elements of the content filter. The passed element will be deleted by the UaContentFilter.

Parameters:

[in]	index	Index of the content filter element in the array
[in]	pElement	UaContentFilterElement to set at the index in the array
[in]	arraySize	Size of the content filter element array filled with this method

---

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

• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uacontentfilter.h
• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uacontentfilter.cpp