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

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

#include <uaaddreferencesitem.h>

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_AddReferencesItem.

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

Constructor & Destructor Documentation

UaAddReferencesItem::UaAddReferencesItem ( const UaAddReferencesItem other)

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

Parameters
otherthe other UaAddReferencesItem used to initialize the object
UaAddReferencesItem::UaAddReferencesItem ( const OpcUa_AddReferencesItem &  other)

Constructs an instance of the class UaAddReferencesItem with values from another OpcUa_AddReferencesItem structure.

Parameters
otherthe other OpcUa_AddReferencesItem used to initialize the object
UaAddReferencesItem::UaAddReferencesItem ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the AddReferencesItem
UaAddReferencesItem::UaAddReferencesItem ( const OpcUa_ExtensionObject &  extensionObject)

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

Parameters
extensionObjectthe extension object containing the AddReferencesItem

Member Function Documentation

void UaAddReferencesItem::attach ( OpcUa_AddReferencesItem *  pValue)

Attaches the data of the parameter pValue.

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

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

Clear the data of the UaAddReferencesItem.

OpcUa_AddReferencesItem * UaAddReferencesItem::clone ( const OpcUa_AddReferencesItem &  source)
static

Copy OpcUa_AddReferencesItem data to a newly allocated OpcUa_AddReferencesItem.

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

Copy OpcUa_AddReferencesItem data to an existing OpcUa_AddReferencesItem structure.

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

Copy UaAddReferencesItem data to a newly allocated OpcUa_AddReferencesItem.

Returns
data to a newly allocated OpcUa_AddReferencesItem.
void UaAddReferencesItem::copyTo ( OpcUa_AddReferencesItem *  pDst) const

Copy UaAddReferencesItem data to an existing OpcUa_AddReferencesItem structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_AddReferencesItem * UaAddReferencesItem::detach ( OpcUa_AddReferencesItem *  pDst)

Detaches the internal AddReferencesItem structure from this class.

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

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

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

Assignment operator.

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

Compare two UaAddReferencesItem if they are similar.

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

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