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

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

#include <uacontentfilterelementresult.h>

Public Member Functions

 UaContentFilterElementResult ()
 Constructs an instance of the class UaContentFilterElementResult with empty default values.
 
 UaContentFilterElementResult (const UaContentFilterElementResult &other)
 Constructs an instance of the class UaContentFilterElementResult with values from another UaContentFilterElementResult object. More...
 
 UaContentFilterElementResult (const OpcUa_ContentFilterElementResult &other)
 Constructs an instance of the class UaContentFilterElementResult with values from another OpcUa_ContentFilterElementResult structure. More...
 
 UaContentFilterElementResult (OpcUa_StatusCode statusCode, const UaStatusCodeArray &operandStatusCodes, const UaDiagnosticInfos &operandDiagnosticInfos)
 Constructs an instance of the class UaContentFilterElementResult with values provided in the constructor.
 
 UaContentFilterElementResult (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaContentFilterElementResult initialized with value from a UaExtensionObject. More...
 
 UaContentFilterElementResult (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaContentFilterElementResult initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaContentFilterElementResult ()
 Destroys the UaContentFilterElementResult object.
 
void clear ()
 Clear the data of the UaContentFilterElementResult. More...
 
bool operator== (const UaContentFilterElementResult &other) const
 Compare two UaContentFilterElementResult if they are similar. More...
 
bool operator!= (const UaContentFilterElementResult &other) const
 Returns true if the other UaContentFilterElementResult is not equal to this. More...
 
UaContentFilterElementResultoperator= (const UaContentFilterElementResult &other)
 Assignment operator. More...
 
OpcUa_ContentFilterElementResultcopy () const
 Copy UaContentFilterElementResult data to a newly allocated OpcUa_ContentFilterElementResult. More...
 
void copyTo (OpcUa_ContentFilterElementResult *pDst) const
 Copy UaContentFilterElementResult data to an existing OpcUa_ContentFilterElementResult structure. More...
 
void attach (OpcUa_ContentFilterElementResult *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUa_ContentFilterElementResultdetach (OpcUa_ContentFilterElementResult *pDst)
 Detaches the internal ContentFilterElementResult structure from this class. More...
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_ContentFilterElementResult.

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

Constructor & Destructor Documentation

UaContentFilterElementResult::UaContentFilterElementResult ( const UaContentFilterElementResult other)

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

Parameters
otherthe other UaContentFilterElementResult used to initialize the object
UaContentFilterElementResult::UaContentFilterElementResult ( const OpcUa_ContentFilterElementResult other)

Constructs an instance of the class UaContentFilterElementResult with values from another OpcUa_ContentFilterElementResult structure.

Parameters
otherthe other OpcUa_ContentFilterElementResult used to initialize the object
UaContentFilterElementResult::UaContentFilterElementResult ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the ContentFilterElementResult
UaContentFilterElementResult::UaContentFilterElementResult ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the ContentFilterElementResult

Member Function Documentation

void UaContentFilterElementResult::attach ( OpcUa_ContentFilterElementResult pValue)

Attaches the data of the parameter pValue.

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

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

Clear the data of the UaContentFilterElementResult.

OpcUa_ContentFilterElementResult * UaContentFilterElementResult::clone ( const OpcUa_ContentFilterElementResult source)
static

Copy OpcUa_ContentFilterElementResult data to a newly allocated OpcUa_ContentFilterElementResult.

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

Copy OpcUa_ContentFilterElementResult data to an existing OpcUa_ContentFilterElementResult structure.

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

Copy UaContentFilterElementResult data to a newly allocated OpcUa_ContentFilterElementResult.

Returns
data to a newly allocated OpcUa_ContentFilterElementResult.
void UaContentFilterElementResult::copyTo ( OpcUa_ContentFilterElementResult pDst) const

Copy UaContentFilterElementResult data to an existing OpcUa_ContentFilterElementResult structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_ContentFilterElementResult * UaContentFilterElementResult::detach ( OpcUa_ContentFilterElementResult pDst)

Detaches the internal ContentFilterElementResult structure from this class.

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

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

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

Assignment operator.

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

Compare two UaContentFilterElementResult if they are similar.

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

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