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

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

#include <uadeletenodesitem.h>

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_DeleteNodesItem.

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

Constructor & Destructor Documentation

UaDeleteNodesItem::UaDeleteNodesItem ( const UaDeleteNodesItem other)

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

Parameters
otherthe other UaDeleteNodesItem used to initialize the object
UaDeleteNodesItem::UaDeleteNodesItem ( const OpcUa_DeleteNodesItem &  other)

Constructs an instance of the class UaDeleteNodesItem with values from another OpcUa_DeleteNodesItem structure.

Parameters
otherthe other OpcUa_DeleteNodesItem used to initialize the object
UaDeleteNodesItem::UaDeleteNodesItem ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the DeleteNodesItem
UaDeleteNodesItem::UaDeleteNodesItem ( const OpcUa_ExtensionObject &  extensionObject)

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

Parameters
extensionObjectthe extension object containing the DeleteNodesItem

Member Function Documentation

void UaDeleteNodesItem::attach ( OpcUa_DeleteNodesItem *  pValue)

Attaches the data of the parameter pValue.

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

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

Clear the data of the UaDeleteNodesItem.

OpcUa_DeleteNodesItem * UaDeleteNodesItem::clone ( const OpcUa_DeleteNodesItem &  source)
static

Copy OpcUa_DeleteNodesItem data to a newly allocated OpcUa_DeleteNodesItem.

Parameters
sourceSource to clone.
Returns
new copy.
void UaDeleteNodesItem::cloneTo ( const OpcUa_DeleteNodesItem &  source,
OpcUa_DeleteNodesItem &  copy 
)
static

Copy OpcUa_DeleteNodesItem data to an existing OpcUa_DeleteNodesItem structure.

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

Copy UaDeleteNodesItem data to a newly allocated OpcUa_DeleteNodesItem.

Returns
data to a newly allocated OpcUa_DeleteNodesItem.
void UaDeleteNodesItem::copyTo ( OpcUa_DeleteNodesItem *  pDst) const

Copy UaDeleteNodesItem data to an existing OpcUa_DeleteNodesItem structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_DeleteNodesItem * UaDeleteNodesItem::detach ( OpcUa_DeleteNodesItem *  pDst)

Detaches the internal DeleteNodesItem structure from this class.

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

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

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

Assignment operator.

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

Compare two UaDeleteNodesItem if they are similar.

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

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