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 for equality. More...

bool	operator!= (const UaDeleteReferencesItem &other) const
	Compare two UaDeleteReferencesItem for inequality. More...

UaDeleteReferencesItem &	operator= (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 to an existing OpcUa_DeleteReferencesItem structure. More...

OpcUa_DeleteReferencesItem *	detach (OpcUa_DeleteReferencesItem *pDst)
	Detaches the internal DeleteReferencesItem structure from this class. More...

UaNodeId	getSourceNodeId () const
	NodeId of the node that contains the reference to delete.

UaNodeId	getReferenceTypeId () const
	NodeId of the ReferenceType that defines the reference to delete.

OpcUa_Boolean	getIsForward () const
	If the value is TRUE, the Server deletes a forward Reference. More...

UaExpandedNodeId	getTargetNodeId () const
	NodeId of the target node of the reference. More...

OpcUa_Boolean	getDeleteBidirectional () const
	A boolean parameter indicating whether the opposite reference from the target node should be deleted together with the node to delete. More...

void	setSourceNodeId (const UaNodeId &sourceNodeId)
	NodeId of the node that contains the reference to delete.

void	setReferenceTypeId (const UaNodeId &referenceTypeId)
	NodeId of the ReferenceType that defines the reference to delete.

void	setIsForward (OpcUa_Boolean isForward)
	If the value is TRUE, the Server deletes a forward Reference. More...

void	setTargetNodeId (const UaExpandedNodeId &targetNodeId)
	NodeId of the target node of the reference. More...

void	setDeleteBidirectional (OpcUa_Boolean deleteBidirectional)
	A boolean parameter indicating whether the opposite reference from the target node should be deleted together with the node to delete. 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.

A structure that is defined as the type of the referencesToDelete parameter of the DeleteReferences service.

Constructor & Destructor Documentation

UaDeleteReferencesItem::UaDeleteReferencesItem ( const UaDeleteReferencesItem & other )

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

Parameters

other the 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

other the 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

extensionObject the 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

extensionObject the extension object containing the DeleteReferencesItem

Member Function Documentation

void UaDeleteReferencesItem::attach ( OpcUa_DeleteReferencesItem * pValue )

Attaches to an existing OpcUa_DeleteReferencesItem structure.

Don't manually free the attached structure afterwards, because UaDeleteReferencesItem is responsible for it now.

Parameters

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

source Source to clone.

Returns: pointer to a newly allocated OpcUa_DeleteReferencesItem.

void UaDeleteReferencesItem::cloneTo	(	const OpcUa_DeleteReferencesItem &	source,
		OpcUa_DeleteReferencesItem &	copy
	)

static

Copy OpcUa_DeleteReferencesItem data to an existing OpcUa_DeleteReferencesItem structure.

Parameters

source	the source of the clone operation.
copy	the destination of the clone operation.

OpcUa_DeleteReferencesItem * UaDeleteReferencesItem::copy ( ) const

Copy UaDeleteReferencesItem data to a newly allocated OpcUa_DeleteReferencesItem.

Returns: pointer to a newly allocated OpcUa_DeleteReferencesItem.

void UaDeleteReferencesItem::copyTo ( OpcUa_DeleteReferencesItem * pDst ) const

Copy UaDeleteReferencesItem data to an existing OpcUa_DeleteReferencesItem structure.

Parameters

pDst	the 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 freeing the DeleteReferencesItem data. If more than one reference exists, the data is copied to pDst instead of being detached.

Parameters

pDst	[out] Pointer to an OpcUa_DeleteReferencesItem structure that receives the DeleteReferencesItem data.

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

OpcUa_Boolean UaDeleteReferencesItem::getDeleteBidirectional ( ) const

A boolean parameter indicating whether the opposite reference from the target node should be deleted together with the node to delete.

It has the following values:

TRUE: delete the specified Reference and the opposite reference from the target node. If the target node is located in a remote Server, the Server is permitted to delete the specified reference only.
FALSE: delete only the specified reference.

OpcUa_Boolean UaDeleteReferencesItem::getIsForward ( ) const

If the value is TRUE, the Server deletes a forward Reference.

If the value is FALSE, the Server deletes an inverse Reference.

UaExpandedNodeId UaDeleteReferencesItem::getTargetNodeId ( ) const

NodeId of the target node of the reference.

If the Server index indicates that the target node is a remote node, then the nodeId shall contain the absolute namespace URI. If the target node is a local node the nodeId shall contain the namespace index.

bool UaDeleteReferencesItem::operator!= ( const UaDeleteReferencesItem & other ) const

Compare two UaDeleteReferencesItem for inequality.

See also: operator==

Parameters

other the UaDeleteReferencesItem to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaDeleteReferencesItem to assign.

Returns: reference to itself.

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

Compare two UaDeleteReferencesItem for equality.

Parameters

other the UaDeleteReferencesItem to compare with.

Returns: true if equal, false if not.

void UaDeleteReferencesItem::setDeleteBidirectional ( OpcUa_Boolean deleteBidirectional )

A boolean parameter indicating whether the opposite reference from the target node should be deleted together with the node to delete.

It has the following values:

TRUE: delete the specified Reference and the opposite reference from the target node. If the target node is located in a remote Server, the Server is permitted to delete the specified reference only.
FALSE: delete only the specified reference.

void UaDeleteReferencesItem::setIsForward ( OpcUa_Boolean isForward )

If the value is TRUE, the Server deletes a forward Reference.

If the value is FALSE, the Server deletes an inverse Reference.

void UaDeleteReferencesItem::setTargetNodeId ( const UaExpandedNodeId & targetNodeId )

NodeId of the target node of the reference.

If the Server index indicates that the target node is a remote node, then the nodeId shall contain the absolute namespace URI. If the target node is a local node the nodeId shall contain the namespace index.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation