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

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

#include <uadeletereferencesitem.h>

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_DeleteReferencesItem.

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

Constructor & Destructor Documentation

UaDeleteReferencesItem::UaDeleteReferencesItem ( const UaDeleteReferencesItem other)

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

Parameters
otherthe other UaDeleteReferencesItem used to initialize the object
UaDeleteReferencesItem::UaDeleteReferencesItem ( const OpcUa_DeleteReferencesItem &  other)

Constructs an instance of the class UaDeleteReferencesItem with values from another OpcUa_DeleteReferencesItem structure.

Parameters
otherthe other OpcUa_DeleteReferencesItem used to initialize the object
UaDeleteReferencesItem::UaDeleteReferencesItem ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the DeleteReferencesItem
UaDeleteReferencesItem::UaDeleteReferencesItem ( const OpcUa_ExtensionObject &  extensionObject)

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

Parameters
extensionObjectthe extension object containing the DeleteReferencesItem

Member Function Documentation

void UaDeleteReferencesItem::attach ( OpcUa_DeleteReferencesItem *  pValue)

Attaches the data of the parameter pValue.

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

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

Clear the data of the UaDeleteReferencesItem.

OpcUa_DeleteReferencesItem * UaDeleteReferencesItem::clone ( const OpcUa_DeleteReferencesItem &  source)
static

Copy OpcUa_DeleteReferencesItem data to a newly allocated OpcUa_DeleteReferencesItem.

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

Copy OpcUa_DeleteReferencesItem data to an existing OpcUa_DeleteReferencesItem structure.

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

Copy UaDeleteReferencesItem data to a newly allocated OpcUa_DeleteReferencesItem.

Returns
data to a newly allocated OpcUa_DeleteReferencesItem.
void UaDeleteReferencesItem::copyTo ( OpcUa_DeleteReferencesItem *  pDst) const

Copy UaDeleteReferencesItem data to an existing OpcUa_DeleteReferencesItem structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_DeleteReferencesItem * UaDeleteReferencesItem::detach ( OpcUa_DeleteReferencesItem *  pDst)

Detaches the internal DeleteReferencesItem structure from this class.

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

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

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

Assignment operator.

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

Compare two UaDeleteReferencesItem if they are similar.

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

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