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

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

#include <uaaddnodesitem.h>

Public Member Functions

 UaAddNodesItem ()
 Constructs an instance of the class UaAddNodesItem with empty default values.
 
 UaAddNodesItem (const UaAddNodesItem &other)
 Constructs an instance of the class UaAddNodesItem with values from another UaAddNodesItem object. More...
 
 UaAddNodesItem (const OpcUa_AddNodesItem &other)
 Constructs an instance of the class UaAddNodesItem with values from another OpcUa_AddNodesItem structure. More...
 
 UaAddNodesItem (const UaExpandedNodeId &parentNodeId, const UaNodeId &referenceTypeId, const UaExpandedNodeId &requestedNewNodeId, const UaQualifiedName &browseName, OpcUa_NodeClass nodeClass, UaExtensionObject &nodeAttributes, const UaExpandedNodeId &typeDefinition)
 Constructs an instance of the class UaAddNodesItem with values provided in the constructor.
 
 UaAddNodesItem (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaAddNodesItem initialized with value from a UaExtensionObject. More...
 
 UaAddNodesItem (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaAddNodesItem initialized with value from an OpcUa_ExtensionObject structure. More...
 
 UaAddNodesItem (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
 UaAddNodesItem (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
 ~UaAddNodesItem ()
 Destroys the UaAddNodesItem object.
 
void clear ()
 Clear the data of the UaAddNodesItem. More...
 
bool operator== (const UaAddNodesItem &other) const
 Compare two UaAddNodesItem if they are similar. More...
 
bool operator!= (const UaAddNodesItem &other) const
 Returns true if the other UaAddNodesItem is not equal to this. More...
 
UaAddNodesItemoperator= (const UaAddNodesItem &other)
 Assignment operator. More...
 
OpcUa_AddNodesItem * copy () const
 Copy UaAddNodesItem data to a newly allocated OpcUa_AddNodesItem. More...
 
void copyTo (OpcUa_AddNodesItem *pDst) const
 Copy UaAddNodesItem data to an existing OpcUa_AddNodesItem structure. More...
 
void attach (const OpcUa_AddNodesItem *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUa_AddNodesItem * detach (OpcUa_AddNodesItem *pDst)
 Detaches the internal AddNodesItem structure from this class. More...
 
void toVariant (UaVariant &variant) const
 
void toVariant (OpcUa_Variant &variant) const
 
void toVariant (UaVariant &variant, OpcUa_Boolean bDetach)
 
void toVariant (OpcUa_Variant &variant, OpcUa_Boolean bDetach)
 
void toDataValue (UaDataValue &dataValue, OpcUa_Boolean updateTimeStamps) const
 
void toDataValue (OpcUa_DataValue &dataValue, OpcUa_Boolean updateTimeStamps) const
 
void toDataValue (UaDataValue &dataValue, OpcUa_Boolean bDetach, OpcUa_Boolean updateTimeStamps)
 
void toDataValue (OpcUa_DataValue &dataValue, OpcUa_Boolean bDetach, OpcUa_Boolean updateTimeStamps)
 
void toExtensionObject (UaExtensionObject &extensionObject) const
 
void toExtensionObject (OpcUa_ExtensionObject &extensionObject) const
 
void toExtensionObject (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
void toExtensionObject (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
OpcUa_StatusCode setAddNodesItem (const UaExtensionObject &extensionObject)
 
OpcUa_StatusCode setAddNodesItem (const OpcUa_ExtensionObject &extensionObject)
 
OpcUa_StatusCode setAddNodesItem (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
OpcUa_StatusCode setAddNodesItem (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
void setAddNodesItem (const UaExpandedNodeId &parentNodeId, const UaNodeId &referenceTypeId, const UaExpandedNodeId &requestedNewNodeId, const UaQualifiedName &browseName, OpcUa_NodeClass nodeClass, UaExtensionObject &nodeAttributes, const UaExpandedNodeId &typeDefinition)
 
UaExpandedNodeId getParentNodeId () const
 
UaNodeId getReferenceTypeId () const
 
UaExpandedNodeId getRequestedNewNodeId () const
 
UaQualifiedName getBrowseName () const
 
OpcUa_NodeClass getNodeClass () const
 
UaExtensionObject getNodeAttributes () const
 
UaExpandedNodeId getTypeDefinition () const
 
void setParentNodeId (const UaExpandedNodeId &parentNodeId)
 
void setReferenceTypeId (const UaNodeId &referenceTypeId)
 
void setRequestedNewNodeId (const UaExpandedNodeId &requestedNewNodeId)
 
void setBrowseName (const UaQualifiedName &browseName)
 
void setNodeClass (OpcUa_NodeClass nodeClass)
 
void setNodeAttributes (UaExtensionObject &nodeAttributes)
 
void setTypeDefinition (const UaExpandedNodeId &typeDefinition)
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_AddNodesItem.

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

Constructor & Destructor Documentation

UaAddNodesItem::UaAddNodesItem ( const UaAddNodesItem other)

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

Parameters
otherthe other UaAddNodesItem used to initialize the object
UaAddNodesItem::UaAddNodesItem ( const OpcUa_AddNodesItem &  other)

Constructs an instance of the class UaAddNodesItem with values from another OpcUa_AddNodesItem structure.

Parameters
otherthe other OpcUa_AddNodesItem used to initialize the object
UaAddNodesItem::UaAddNodesItem ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the AddNodesItem
UaAddNodesItem::UaAddNodesItem ( const OpcUa_ExtensionObject &  extensionObject)

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

Parameters
extensionObjectthe extension object containing the AddNodesItem

Member Function Documentation

void UaAddNodesItem::attach ( const OpcUa_AddNodesItem *  pValue)

Attaches the data of the parameter pValue.

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

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

Clear the data of the UaAddNodesItem.

OpcUa_AddNodesItem * UaAddNodesItem::clone ( const OpcUa_AddNodesItem &  source)
static

Copy OpcUa_AddNodesItem data to a newly allocated OpcUa_AddNodesItem.

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

Copy OpcUa_AddNodesItem data to an existing OpcUa_AddNodesItem structure.

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

Copy UaAddNodesItem data to a newly allocated OpcUa_AddNodesItem.

Returns
data to a newly allocated OpcUa_AddNodesItem.
void UaAddNodesItem::copyTo ( OpcUa_AddNodesItem *  pDst) const

Copy UaAddNodesItem data to an existing OpcUa_AddNodesItem structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_AddNodesItem * UaAddNodesItem::detach ( OpcUa_AddNodesItem *  pDst)

Detaches the internal AddNodesItem structure from this class.

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

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

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

Assignment operator.

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

Compare two UaAddNodesItem if they are similar.

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

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