C++ Based OPC UA Client/Server SDK
1.6.1.391
|
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 for equality. More... | |
bool | operator!= (const UaDeleteNodesItem &other) const |
Compare two UaDeleteNodesItem for inequality. More... | |
UaDeleteNodesItem & | operator= (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 to an existing OpcUa_DeleteNodesItem structure. More... | |
OpcUa_DeleteNodesItem * | detach (OpcUa_DeleteNodesItem *pDst) |
Detaches the internal DeleteNodesItem structure from this class. More... | |
UaNodeId | getNodeId () const |
NodeId of the node to delete. | |
OpcUa_Boolean | getDeleteTargetReferences () const |
A boolean parameter indicating whether to delete references for which the node to delete is the target node. More... | |
void | setNodeId (const UaNodeId &nodeId) |
NodeId of the node to delete. | |
void | setDeleteTargetReferences (OpcUa_Boolean deleteTargetReferences) |
A boolean parameter indicating whether to delete references for which the node to delete is the target node. 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 OpcUa_DeleteNodesItem data to an existing OpcUa_DeleteNodesItem structure. More... | |
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.
A structure that is defined as the type of the nodesToDelete parameter of the DeleteNodes Service.
UaDeleteNodesItem::UaDeleteNodesItem | ( | const UaDeleteNodesItem & | other | ) |
Constructs an instance of the class UaDeleteNodesItem with values from another UaDeleteNodesItem object.
other | the 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.
other | the 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.
extensionObject | the 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.
extensionObject | the extension object containing the DeleteNodesItem |
void UaDeleteNodesItem::attach | ( | OpcUa_DeleteNodesItem * | pValue | ) |
Attaches to an existing OpcUa_DeleteNodesItem structure.
Don't manually free the attached structure afterwards, because UaDeleteNodesItem is responsible for it now.
pValue | [in] Parameter to attach to. |
void UaDeleteNodesItem::clear | ( | ) |
Clear the data of the UaDeleteNodesItem.
|
static |
Copy OpcUa_DeleteNodesItem data to a newly allocated OpcUa_DeleteNodesItem.
source | Source to clone. |
|
static |
Copy OpcUa_DeleteNodesItem data to an existing OpcUa_DeleteNodesItem structure.
source | the source of the clone operation. |
copy | the destination of the clone operation. |
OpcUa_DeleteNodesItem * UaDeleteNodesItem::copy | ( | ) | const |
Copy UaDeleteNodesItem data to a newly allocated OpcUa_DeleteNodesItem.
void UaDeleteNodesItem::copyTo | ( | OpcUa_DeleteNodesItem * | pDst | ) | const |
Copy UaDeleteNodesItem data to an existing OpcUa_DeleteNodesItem structure.
pDst | the 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 freeing the DeleteNodesItem data. If more than one reference exists, the data is copied to pDst instead of being detached.
pDst | [out] Pointer to an OpcUa_DeleteNodesItem structure that receives the DeleteNodesItem data. |
OpcUa_Boolean UaDeleteNodesItem::getDeleteTargetReferences | ( | ) | const |
A boolean parameter indicating whether to delete references for which the node to delete is the target node.
It has the following values:
The Server cannot guarantee that it is able to delete all references from target nodes if this parameter is TRUE.
bool UaDeleteNodesItem::operator!= | ( | const UaDeleteNodesItem & | other | ) | const |
Compare two UaDeleteNodesItem for inequality.
other | the UaDeleteNodesItem to compare with. |
UaDeleteNodesItem & UaDeleteNodesItem::operator= | ( | const UaDeleteNodesItem & | other | ) |
bool UaDeleteNodesItem::operator== | ( | const UaDeleteNodesItem & | other | ) | const |
Compare two UaDeleteNodesItem for equality.
other | the UaDeleteNodesItem to compare with. |
void UaDeleteNodesItem::setDeleteTargetReferences | ( | OpcUa_Boolean | deleteTargetReferences | ) |
A boolean parameter indicating whether to delete references for which the node to delete is the target node.
It has the following values:
The Server cannot guarantee that it is able to delete all references from target nodes if this parameter is TRUE.