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

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

#include <opcuadi_fetchresultdatadatatype.h>

Public Member Functions

 FetchResultDataDataType ()
 Constructs an instance of the class FetchResultDataDataType with empty default values.
 
 FetchResultDataDataType (const FetchResultDataDataType &other)
 Constructs an instance of the class FetchResultDataDataType with values from another FetchResultDataDataType object. More...
 
 FetchResultDataDataType (const OpcUaDi_FetchResultDataDataType &other)
 Constructs an instance of the class FetchResultDataDataType with values from another OpcUaDi_FetchResultDataDataType structure. More...
 
 FetchResultDataDataType (OpcUa_Int32 SequenceNumber, OpcUa_Boolean EndOfResults, const ParameterResultDataTypes &ParameterDefs)
 Constructs an instance of the class FetchResultDataDataType with values provided in the constructor.
 
 FetchResultDataDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class FetchResultDataDataType initialized with value from a UaExtensionObject. More...
 
 FetchResultDataDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class FetchResultDataDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~FetchResultDataDataType ()
 Destroys the FetchResultDataDataType object.
 
void clear ()
 Clear the data of the FetchResultDataDataType.
 
bool operator== (const FetchResultDataDataType &other) const
 Compare two FetchResultDataDataType if they are similar. More...
 
bool operator!= (const FetchResultDataDataType &other) const
 Returns true if the other FetchResultDataDataType is not equal to this. More...
 
FetchResultDataDataTypeoperator= (const FetchResultDataDataType &other)
 Assignment operator. More...
 
OpcUaDi_FetchResultDataDataType * copy () const
 Copy FetchResultDataDataType data to a newly allocated OpcUaDi_FetchResultDataDataType. More...
 
void copyTo (OpcUaDi_FetchResultDataDataType *pDst) const
 Copy FetchResultDataDataType data to an existing OpcUaDi_FetchResultDataDataType structure. More...
 
void attach (const OpcUaDi_FetchResultDataDataType *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUaDi_FetchResultDataDataType * detach (OpcUaDi_FetchResultDataDataType *pDst)
 Detaches the internal FetchResultDataDataType structure from this class. More...
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUaDi_FetchResultDataDataType.

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

Constructor & Destructor Documentation

OpcUaDi::FetchResultDataDataType::FetchResultDataDataType ( const FetchResultDataDataType other)

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

Parameters
otherthe other UaFetchResultDataDataType used to initialize the object
OpcUaDi::FetchResultDataDataType::FetchResultDataDataType ( const OpcUaDi_FetchResultDataDataType &  other)

Constructs an instance of the class FetchResultDataDataType with values from another OpcUaDi_FetchResultDataDataType structure.

Parameters
otherthe other OpcUaDi_FetchResultDataDataType used to initialize the object
OpcUaDi::FetchResultDataDataType::FetchResultDataDataType ( const UaExtensionObject extensionObject)

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

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

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

Parameters
extensionObjectthe extension object containing the FetchResultDataDataType

Member Function Documentation

void OpcUaDi::FetchResultDataDataType::attach ( const OpcUaDi_FetchResultDataDataType *  pValue)

Attaches the data of the parameter pValue.

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

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

Copy OpcUaDi_FetchResultDataDataType data to a newly allocated OpcUaDi_FetchResultDataDataType.

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

Copy OpcUaDi_FetchResultDataDataType data to an existing OpcUaDi_FetchResultDataDataType structure.

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

Copy FetchResultDataDataType data to a newly allocated OpcUaDi_FetchResultDataDataType.

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

Copy FetchResultDataDataType data to an existing OpcUaDi_FetchResultDataDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUaDi_FetchResultDataDataType * OpcUaDi::FetchResultDataDataType::detach ( OpcUaDi_FetchResultDataDataType *  pDst)

Detaches the internal FetchResultDataDataType structure from this class.

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

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

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

Assignment operator.

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

Compare two FetchResultDataDataType if they are similar.

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

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