UA Server SDK C++ Bundle  1.4.1.271
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
OpcUaDi::ParameterResultDataType Class Reference

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

#include <opcuadi_parameterresultdatatype.h>

Public Member Functions

 ParameterResultDataType ()
 Constructs an instance of the class ParameterResultDataType with empty default values.
 
 ParameterResultDataType (const ParameterResultDataType &other)
 Constructs an instance of the class ParameterResultDataType with values from another ParameterResultDataType object. More...
 
 ParameterResultDataType (const OpcUaDi_ParameterResultDataType &other)
 Constructs an instance of the class ParameterResultDataType with values from another OpcUaDi_ParameterResultDataType structure. More...
 
 ParameterResultDataType (const UaQualifiedNameArray &NodePath, OpcUa_StatusCode StatusCode, const OpcUa_DiagnosticInfo &Diagnostics)
 Constructs an instance of the class ParameterResultDataType with values provided in the constructor.
 
 ParameterResultDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class ParameterResultDataType initialized with value from a UaExtensionObject. More...
 
 ParameterResultDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class ParameterResultDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~ParameterResultDataType ()
 Destroys the ParameterResultDataType object.
 
void clear ()
 Clear the data of the ParameterResultDataType.
 
bool operator== (const ParameterResultDataType &other) const
 Compare two ParameterResultDataType if they are similar. More...
 
bool operator!= (const ParameterResultDataType &other) const
 Returns true if the other ParameterResultDataType is not equal to this. More...
 
ParameterResultDataTypeoperator= (const ParameterResultDataType &other)
 Assignment operator. More...
 
OpcUaDi_ParameterResultDataType * copy () const
 Copy ParameterResultDataType data to a newly allocated OpcUaDi_ParameterResultDataType. More...
 
void copyTo (OpcUaDi_ParameterResultDataType *pDst) const
 Copy ParameterResultDataType data to an existing OpcUaDi_ParameterResultDataType structure. More...
 
void attach (const OpcUaDi_ParameterResultDataType *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUaDi_ParameterResultDataType * detach (OpcUaDi_ParameterResultDataType *pDst)
 Detaches the internal ParameterResultDataType structure from this class. More...
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUaDi_ParameterResultDataType.

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

Constructor & Destructor Documentation

OpcUaDi::ParameterResultDataType::ParameterResultDataType ( const ParameterResultDataType other)

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

Parameters
otherthe other UaParameterResultDataType used to initialize the object
OpcUaDi::ParameterResultDataType::ParameterResultDataType ( const OpcUaDi_ParameterResultDataType &  other)

Constructs an instance of the class ParameterResultDataType with values from another OpcUaDi_ParameterResultDataType structure.

Parameters
otherthe other OpcUaDi_ParameterResultDataType used to initialize the object
OpcUaDi::ParameterResultDataType::ParameterResultDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the ParameterResultDataType
OpcUaDi::ParameterResultDataType::ParameterResultDataType ( const OpcUa_ExtensionObject &  extensionObject)

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

Parameters
extensionObjectthe extension object containing the ParameterResultDataType

Member Function Documentation

void OpcUaDi::ParameterResultDataType::attach ( const OpcUaDi_ParameterResultDataType *  pValue)

Attaches the data of the parameter pValue.

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

Parameters
[in]pValueParameter to attach to.
OpcUaDi_ParameterResultDataType * OpcUaDi::ParameterResultDataType::clone ( const OpcUaDi_ParameterResultDataType &  source)
static

Copy OpcUaDi_ParameterResultDataType data to a newly allocated OpcUaDi_ParameterResultDataType.

Parameters
sourceSource to clone.
Returns
new copy.
void OpcUaDi::ParameterResultDataType::cloneTo ( const OpcUaDi_ParameterResultDataType &  source,
OpcUaDi_ParameterResultDataType &  copy 
)
static

Copy OpcUaDi_ParameterResultDataType data to an existing OpcUaDi_ParameterResultDataType structure.

Parameters
sourcethe source of the clone operation.
copythe destination of the clone operation.
OpcUaDi_ParameterResultDataType * OpcUaDi::ParameterResultDataType::copy ( ) const

Copy ParameterResultDataType data to a newly allocated OpcUaDi_ParameterResultDataType.

Returns
data to a newly allocated OpcUaDi_ParameterResultDataType.
void OpcUaDi::ParameterResultDataType::copyTo ( OpcUaDi_ParameterResultDataType *  pDst) const

Copy ParameterResultDataType data to an existing OpcUaDi_ParameterResultDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUaDi_ParameterResultDataType * OpcUaDi::ParameterResultDataType::detach ( OpcUaDi_ParameterResultDataType *  pDst)

Detaches the internal ParameterResultDataType structure from this class.

This way you take over the control of releasing the ParameterResultDataType data. If more than one references exist, the data is copied to pDst instead of being detached.

Returns
If the functions succeeds pDst is returned, otherwise 0 is returned.
Parameters
[out]pDstPointer to OpcUaDi_ParameterResultDataType structure that receives the ParameterResultDataType data.
bool OpcUaDi::ParameterResultDataType::operator!= ( const ParameterResultDataType other) const

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

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

Assignment operator.

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

Compare two ParameterResultDataType if they are similar.

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

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