C++ Based OPC UA Client/Server SDK  1.5.5.355

Wrapper class for the UA stack structure OpcUa_EventFilterResult. More...

#include <uaeventfilterresult.h>

Public Member Functions

 UaEventFilterResult ()
 Constructs an instance of the class UaEventFilterResult with empty default values.
 
 UaEventFilterResult (const UaEventFilterResult &other)
 Constructs an instance of the class UaEventFilterResult with values from another UaEventFilterResult object. More...
 
 UaEventFilterResult (const OpcUa_EventFilterResult &other)
 Constructs an instance of the class UaEventFilterResult with values from another OpcUa_EventFilterResult structure. More...
 
 UaEventFilterResult (const UaStatusCodeArray &selectClauseResults, const UaDiagnosticInfos &selectClauseDiagnosticInfos, const UaContentFilterResult &whereClauseResult)
 Constructs an instance of the class UaEventFilterResult with values provided in the constructor.
 
 UaEventFilterResult (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaEventFilterResult initialized with value from a UaExtensionObject. More...
 
 UaEventFilterResult (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaEventFilterResult initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaEventFilterResult ()
 Destroys the UaEventFilterResult object.
 
void clear ()
 Clear the data of the UaEventFilterResult. More...
 
bool operator== (const UaEventFilterResult &other) const
 Compare two UaEventFilterResult if they are similar. More...
 
bool operator!= (const UaEventFilterResult &other) const
 Returns true if the other UaEventFilterResult is not equal to this. More...
 
UaEventFilterResultoperator= (const UaEventFilterResult &other)
 Assignment operator. More...
 
OpcUa_EventFilterResultcopy () const
 Copy UaEventFilterResult data to a newly allocated OpcUa_EventFilterResult. More...
 
void copyTo (OpcUa_EventFilterResult *pDst) const
 Copy UaEventFilterResult data to an existing OpcUa_EventFilterResult structure. More...
 
void attach (OpcUa_EventFilterResult *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUa_EventFilterResultdetach (OpcUa_EventFilterResult *pDst)
 Detaches the internal EventFilterResult structure from this class. More...
 

Static Public Member Functions

static OpcUa_EventFilterResultclone (const OpcUa_EventFilterResult &source)
 Copy OpcUa_EventFilterResult data to a newly allocated OpcUa_EventFilterResult. More...
 
static void cloneTo (const OpcUa_EventFilterResult &source, OpcUa_EventFilterResult &copy)
 Copy OpcUa_EventFilterResult data to an existing OpcUa_EventFilterResult structure. More...
 

Detailed Description

Wrapper class for the UA stack structure OpcUa_EventFilterResult.

This class encapsulates the native OpcUa_EventFilterResult structure and handles memory allocation and cleanup for you. UaEventFilterResult uses implicit sharing to avoid needless copying and to boost the performance. Only if you modify a shared EventFilterResult it creates a copy for that (copy-on-write). So assigning another UaEventFilterResult or passing it as parameter needs constant time and is nearly as fast as assigning a pointer.

Constructor & Destructor Documentation

UaEventFilterResult::UaEventFilterResult ( const UaEventFilterResult other)

Constructs an instance of the class UaEventFilterResult with values from another UaEventFilterResult object.

Parameters
otherthe other UaEventFilterResult used to initialize the object
UaEventFilterResult::UaEventFilterResult ( const OpcUa_EventFilterResult other)

Constructs an instance of the class UaEventFilterResult with values from another OpcUa_EventFilterResult structure.

Parameters
otherthe other OpcUa_EventFilterResult used to initialize the object
UaEventFilterResult::UaEventFilterResult ( const UaExtensionObject extensionObject)

Constructs an instance of the class UaEventFilterResult initialized with value from a UaExtensionObject.

Parameters
extensionObjectthe extension object containing the EventFilterResult
UaEventFilterResult::UaEventFilterResult ( const OpcUa_ExtensionObject extensionObject)

Constructs an instance of the class UaEventFilterResult initialized with value from an OpcUa_ExtensionObject structure.

Parameters
extensionObjectthe extension object containing the EventFilterResult

Member Function Documentation

void UaEventFilterResult::attach ( OpcUa_EventFilterResult pValue)

Attaches the data of the parameter pValue.

Don't clear the data of pValue afterwards manually, because UaEventFilterResult is responsible for it now.

Parameters
[in]pValueParameter to attach to.
void UaEventFilterResult::clear ( )

Clear the data of the UaEventFilterResult.

OpcUa_EventFilterResult * UaEventFilterResult::clone ( const OpcUa_EventFilterResult source)
static

Copy OpcUa_EventFilterResult data to a newly allocated OpcUa_EventFilterResult.

Parameters
sourceSource to clone.
Returns
new copy.
void UaEventFilterResult::cloneTo ( const OpcUa_EventFilterResult source,
OpcUa_EventFilterResult copy 
)
static

Copy OpcUa_EventFilterResult data to an existing OpcUa_EventFilterResult structure.

Parameters
sourcethe source of the clone operation.
copythe destination of the clone operation.
OpcUa_EventFilterResult * UaEventFilterResult::copy ( ) const

Copy UaEventFilterResult data to a newly allocated OpcUa_EventFilterResult.

Returns
data to a newly allocated OpcUa_EventFilterResult.
void UaEventFilterResult::copyTo ( OpcUa_EventFilterResult pDst) const

Copy UaEventFilterResult data to an existing OpcUa_EventFilterResult structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_EventFilterResult * UaEventFilterResult::detach ( OpcUa_EventFilterResult pDst)

Detaches the internal EventFilterResult structure from this class.

This way you take over the control of releasing the EventFilterResult data. If more than one reference exists, the data is copied to pDst instead of being detached.

Returns
If the function succeeds, pDst is returned, otherwise 0 is returned.
Parameters
[out]pDstPointer to OpcUa_EventFilterResult structure that receives the EventFilterResult data.
bool UaEventFilterResult::operator!= ( const UaEventFilterResult other) const

Returns true if the other UaEventFilterResult is not equal to this.

See also
operator==
Parameters
otherthe UaEventFilterResult to compare.
Returns
true if other is not equal to this.
UaEventFilterResult & UaEventFilterResult::operator= ( const UaEventFilterResult other)

Assignment operator.

Parameters
otherthe UaEventFilterResult to assign.
Returns
Assignment operator.
bool UaEventFilterResult::operator== ( const UaEventFilterResult other) const

Compare two UaEventFilterResult if they are similar.

Parameters
otherthe UaEventFilterResult to compare.
Returns
true if similar, false if not.

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