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

OPC UA ElementOperand used in ContentFilterElement. More...

#include <uacontentfilter.h>

Inherits UaFilterOperand.

Public Member Functions

 UaElementOperand ()
 Constructs an empty element filter operand object.
 
virtual ~UaElementOperand ()
 Destroys the element filter operand object.
 
UaFilterOperand::FilterOperandType getFilterOperandType () const
 Returns the filter operand type Element.
 
void setIndex (OpcUa_UInt32 index)
 Sets the index of the element operand. More...
 
OpcUa_UInt32 index () const
 Returns the index of the element operand.
 
void setContentFilterElement (UaContentFilterElement *pElement)
 Sets the content filter element. More...
 
UaContentFilterElementpContentFilterElement () const
 Returns the contained content filter element (Server use only). More...
 
UaStatus setContentFilterElement (UaContentFilter *pUaContentFilter, OpcUa_UInt32 noOfElements, const OpcUa_ContentFilterElement *pElements, OpcUa_UInt32 elementIndex, OpcUa_EventFilterResult *pEventFilterResult, OpcUa_Boolean &hasFilterError)
 Sets the content filter element (Server use only). More...
 
- Public Member Functions inherited from UaFilterOperand
 UaFilterOperand ()
 Constructs an empty filter operand object.
 
virtual ~UaFilterOperand ()
 Destroys the filter operand object.
 

Additional Inherited Members

- Public Types inherited from UaFilterOperand
enum  FilterOperandType { Element, Literal, SimpleAttribute }
 FilterOperandType enumeration. More...
 

Detailed Description

OPC UA ElementOperand used in ContentFilterElement.

This class is used to build and hold an OPC UA ElementOperand used in the UaContentFilterElement. This class is concrete implementation of the abstract UaFilterOperand. It contains a content filter element. This type is used to build a logic tree of sub elements by linking the operand of one element to a sub-element

Member Function Documentation

UaContentFilterElement * UaElementOperand::pContentFilterElement ( ) const

Returns the contained content filter element (Server use only).

This method is used only in the server implementation to build a logical tree.

void UaElementOperand::setContentFilterElement ( UaContentFilterElement pElement)

Sets the content filter element.

The passed element will be deleted by the UaElementOperand (Server use only).

This method is used only in the server implementation to build a logical tree.

Parameters
[in]pElementThe element itself
UaStatus UaElementOperand::setContentFilterElement ( UaContentFilter pUaContentFilter,
OpcUa_UInt32  noOfElements,
const OpcUa_ContentFilterElement pElements,
OpcUa_UInt32  elementIndex,
OpcUa_EventFilterResult pEventFilterResult,
OpcUa_Boolean &  hasFilterError 
)

Sets the content filter element (Server use only).

This method is used only in the server implementation to build a logical tree.

Returns
Status code
Parameters
[in]pUaContentFilterA pointer set to the filter
[in]noOfElementsThe number of elements
[in]pElementsThe elements itself
[in]elementIndexThe index of the given element
[in,out]pEventFilterResultThe result of the filter operation
[in,out]hasFilterErrorIndicates if errors occured in the filter operation
void UaElementOperand::setIndex ( OpcUa_UInt32  index)

Sets the index of the element operand.

Parameters
[in]indexthe index of the element operand

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