C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537

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

#include <uacontentfilterresult.h>

Public Member Functions

 UaContentFilterResult ()
 Constructs an instance of the class UaContentFilterResult with empty default values.
 
 UaContentFilterResult (const UaContentFilterResult &other)
 Constructs an instance of the class UaContentFilterResult with values from another UaContentFilterResult object. More...
 
 UaContentFilterResult (const OpcUa_ContentFilterResult &other)
 Constructs an instance of the class UaContentFilterResult with values from another OpcUa_ContentFilterResult structure. More...
 
 UaContentFilterResult (const UaContentFilterElementResults &elementResults, const UaDiagnosticInfos &elementDiagnosticInfos)
 Constructs an instance of the class UaContentFilterResult with values provided in the constructor.
 
 UaContentFilterResult (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaContentFilterResult initialized with value from a UaExtensionObject. More...
 
 UaContentFilterResult (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaContentFilterResult initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaContentFilterResult ()
 Destroys the UaContentFilterResult object.
 
void clear ()
 Clear the data of the UaContentFilterResult. More...
 
bool operator== (const UaContentFilterResult &other) const
 Compare two UaContentFilterResult if they are similar. More...
 
bool operator!= (const UaContentFilterResult &other) const
 Returns true if the other UaContentFilterResult is not equal to this. More...
 
UaContentFilterResultoperator= (const UaContentFilterResult &other)
 Assignment operator. More...
 
OpcUa_ContentFilterResultcopy () const
 Copy UaContentFilterResult data to a newly allocated OpcUa_ContentFilterResult. More...
 
void copyTo (OpcUa_ContentFilterResult *pDst) const
 Copy UaContentFilterResult data to an existing OpcUa_ContentFilterResult structure. More...
 
void attach (OpcUa_ContentFilterResult *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUa_ContentFilterResultdetach (OpcUa_ContentFilterResult *pDst)
 Detaches the internal ContentFilterResult structure from this class. More...
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_ContentFilterResult.

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

Constructor & Destructor Documentation

UaContentFilterResult::UaContentFilterResult ( const UaContentFilterResult other)

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

Parameters
otherthe other UaContentFilterResult used to initialize the object
UaContentFilterResult::UaContentFilterResult ( const OpcUa_ContentFilterResult other)

Constructs an instance of the class UaContentFilterResult with values from another OpcUa_ContentFilterResult structure.

Parameters
otherthe other OpcUa_ContentFilterResult used to initialize the object
UaContentFilterResult::UaContentFilterResult ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the ContentFilterResult
UaContentFilterResult::UaContentFilterResult ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the ContentFilterResult

Member Function Documentation

void UaContentFilterResult::attach ( OpcUa_ContentFilterResult pValue)

Attaches the data of the parameter pValue.

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

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

Clear the data of the UaContentFilterResult.

OpcUa_ContentFilterResult * UaContentFilterResult::clone ( const OpcUa_ContentFilterResult source)
static

Copy OpcUa_ContentFilterResult data to a newly allocated OpcUa_ContentFilterResult.

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

Copy OpcUa_ContentFilterResult data to an existing OpcUa_ContentFilterResult structure.

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

Copy UaContentFilterResult data to a newly allocated OpcUa_ContentFilterResult.

Returns
data to a newly allocated OpcUa_ContentFilterResult.
void UaContentFilterResult::copyTo ( OpcUa_ContentFilterResult pDst) const

Copy UaContentFilterResult data to an existing OpcUa_ContentFilterResult structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_ContentFilterResult * UaContentFilterResult::detach ( OpcUa_ContentFilterResult pDst)

Detaches the internal ContentFilterResult structure from this class.

This way you take over the control of releasing the ContentFilterResult 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_ContentFilterResult structure that receives the ContentFilterResult data.
bool UaContentFilterResult::operator!= ( const UaContentFilterResult other) const

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

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

Assignment operator.

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

Compare two UaContentFilterResult if they are similar.

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

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