C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
OpcUaDi::TransferResultDataDataType Class Reference

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

#include <opcuadi_transferresultdatadatatype.h>

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUaDi_TransferResultDataDataType.

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

Constructor & Destructor Documentation

OpcUaDi::TransferResultDataDataType::TransferResultDataDataType ( const TransferResultDataDataType other)

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

Parameters
otherthe other UaTransferResultDataDataType used to initialize the object
OpcUaDi::TransferResultDataDataType::TransferResultDataDataType ( const OpcUaDi_TransferResultDataDataType &  other)

Constructs an instance of the class TransferResultDataDataType with values from another OpcUaDi_TransferResultDataDataType structure.

Parameters
otherthe other OpcUaDi_TransferResultDataDataType used to initialize the object
OpcUaDi::TransferResultDataDataType::TransferResultDataDataType ( const UaExtensionObject extensionObject)

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

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

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

Parameters
extensionObjectthe extension object containing the TransferResultDataDataType

Member Function Documentation

void OpcUaDi::TransferResultDataDataType::attach ( const OpcUaDi_TransferResultDataDataType *  pValue)

Attaches the data of the parameter pValue.

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

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

Copy OpcUaDi_TransferResultDataDataType data to a newly allocated OpcUaDi_TransferResultDataDataType.

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

Copy OpcUaDi_TransferResultDataDataType data to an existing OpcUaDi_TransferResultDataDataType structure.

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

Copy TransferResultDataDataType data to a newly allocated OpcUaDi_TransferResultDataDataType.

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

Copy TransferResultDataDataType data to an existing OpcUaDi_TransferResultDataDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUaDi_TransferResultDataDataType * OpcUaDi::TransferResultDataDataType::detach ( OpcUaDi_TransferResultDataDataType *  pDst)

Detaches the internal TransferResultDataDataType structure from this class.

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

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

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

Assignment operator.

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

Compare two TransferResultDataDataType if they are similar.

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

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