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)
	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.

A structure that is defined as the type of the nodesToDelete parameter of the DeleteNodes Service.

Constructor & Destructor Documentation

UaDeleteNodesItem::UaDeleteNodesItem ( const UaDeleteNodesItem & other )

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

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

extensionObject the extension object containing the DeleteNodesItem

Member Function Documentation

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.

Parameters

pValue [in] Parameter 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

source Source to clone.

Returns: pointer to a newly allocated OpcUa_DeleteNodesItem.

void UaDeleteNodesItem::cloneTo	(	const OpcUa_DeleteNodesItem &	source,
		OpcUa_DeleteNodesItem &	copy
	)

static

Copy OpcUa_DeleteNodesItem data to an existing OpcUa_DeleteNodesItem structure.

Parameters

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.

Returns: pointer to a newly allocated OpcUa_DeleteNodesItem.

void UaDeleteNodesItem::copyTo ( OpcUa_DeleteNodesItem * pDst ) const

Copy UaDeleteNodesItem data to an existing OpcUa_DeleteNodesItem structure.

Parameters

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.

Parameters

pDst	[out] Pointer to an OpcUa_DeleteNodesItem structure that receives the DeleteNodesItem data.

Returns: If the function succeeds, pDst is returned, otherwise 0 is returned.

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:

TRUE: delete References in TargetNodes that Reference the Node to delete.
FALSE: delete only the References for which the Node to delete is the source.

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.

See also: operator==

Parameters

other the UaDeleteNodesItem to compare with.

Returns: true if not equal, false otherwise.

UaDeleteNodesItem & UaDeleteNodesItem::operator= ( const UaDeleteNodesItem & other )

Assignment operator.

Parameters

other the UaDeleteNodesItem to assign.

Returns: reference to itself.

bool UaDeleteNodesItem::operator== ( const UaDeleteNodesItem & other ) const

Compare two UaDeleteNodesItem for equality.

Parameters

other the UaDeleteNodesItem to compare with.

Returns: true if equal, false if not.

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:

TRUE: delete References in TargetNodes that Reference the Node to delete.
FALSE: delete only the References for which the Node to delete is the source.

The Server cannot guarantee that it is able to delete all references from target nodes if this parameter is TRUE.

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

C:/work/uasdkcpp/src/uabase/uabasecpp/uadeletenodesitem.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uadeletenodesitem.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation