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

#include <uaaliasnamedatatype.h>

Public Member Functions
	UaAliasNameDataType ()
	Constructs an instance of the class UaAliasNameDataType with empty default values.

	UaAliasNameDataType (const UaAliasNameDataType &other)
	Constructs an instance of the class UaAliasNameDataType with values from another UaAliasNameDataType object. More...

	UaAliasNameDataType (const OpcUa_AliasNameDataType &other)
	Constructs an instance of the class UaAliasNameDataType with values from another OpcUa_AliasNameDataType structure. More...

	UaAliasNameDataType (const UaQualifiedName &aliasName, const UaExpandedNodeIdArray &referencedNodes)
	Constructs an instance of the class UaAliasNameDataType with values provided in the constructor.

	UaAliasNameDataType (const UaExtensionObject &extensionObject)
	Constructs an instance of the class UaAliasNameDataType initialized with value from a UaExtensionObject. More...

	UaAliasNameDataType (const OpcUa_ExtensionObject &extensionObject)
	Constructs an instance of the class UaAliasNameDataType initialized with value from an OpcUa_ExtensionObject structure. More...

	~UaAliasNameDataType ()
	Destroys the UaAliasNameDataType object.

void	clear ()
	Clear the data of the UaAliasNameDataType. More...

bool	operator== (const UaAliasNameDataType &other) const
	Compare two UaAliasNameDataType for equality. More...

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

UaAliasNameDataType &	operator= (const UaAliasNameDataType &other)
	Assignment operator. More...

OpcUa_AliasNameDataType *	copy () const
	Copy UaAliasNameDataType data to a newly allocated OpcUa_AliasNameDataType. More...

void	copyTo (OpcUa_AliasNameDataType *pDst) const
	Copy UaAliasNameDataType data to an existing OpcUa_AliasNameDataType structure. More...

void	attach (OpcUa_AliasNameDataType *pValue)
	Attaches to an existing OpcUa_AliasNameDataType structure. More...

OpcUa_AliasNameDataType *	detach (OpcUa_AliasNameDataType *pDst)
	Detaches the internal AliasNameDataType structure from this class. More...

UaQualifiedName	getAliasName () const
	Returns the AliasName.

void	getReferencedNodes (UaExpandedNodeIdArray &referencedNodes) const
	Returns the ReferencedNodes.

void	setAliasName (const UaQualifiedName &aliasName)
	Sets the AliasName.

void	setReferencedNodes (const UaExpandedNodeIdArray &referencedNodes)
	Sets the ReferencedNodes.

Static Public Member Functions
static OpcUa_AliasNameDataType *	clone (const OpcUa_AliasNameDataType &source)
	Copy OpcUa_AliasNameDataType data to a newly allocated OpcUa_AliasNameDataType. More...

static void	cloneTo (const OpcUa_AliasNameDataType &source, OpcUa_AliasNameDataType &copy)
	Copy OpcUa_AliasNameDataType data to an existing OpcUa_AliasNameDataType structure. More...

Detailed Description

Wrapper class for the UA stack structure OpcUa_AliasNameDataType.

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

Constructor & Destructor Documentation

UaAliasNameDataType::UaAliasNameDataType ( const UaAliasNameDataType & other )

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

Parameters

other the other UaAliasNameDataType used to initialize the object

UaAliasNameDataType::UaAliasNameDataType ( const OpcUa_AliasNameDataType & other )

Constructs an instance of the class UaAliasNameDataType with values from another OpcUa_AliasNameDataType structure.

Parameters

other the other OpcUa_AliasNameDataType used to initialize the object

UaAliasNameDataType::UaAliasNameDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the AliasNameDataType

UaAliasNameDataType::UaAliasNameDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the AliasNameDataType

Member Function Documentation

void UaAliasNameDataType::attach ( OpcUa_AliasNameDataType * pValue )

Attaches to an existing OpcUa_AliasNameDataType structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaAliasNameDataType::clear ( )

Clear the data of the UaAliasNameDataType.

OpcUa_AliasNameDataType * UaAliasNameDataType::clone ( const OpcUa_AliasNameDataType & source )

static

Copy OpcUa_AliasNameDataType data to a newly allocated OpcUa_AliasNameDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_AliasNameDataType.

void UaAliasNameDataType::cloneTo	(	const OpcUa_AliasNameDataType &	source,
		OpcUa_AliasNameDataType &	copy
	)

static

Copy OpcUa_AliasNameDataType data to an existing OpcUa_AliasNameDataType structure.

Parameters

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

OpcUa_AliasNameDataType * UaAliasNameDataType::copy ( ) const

Copy UaAliasNameDataType data to a newly allocated OpcUa_AliasNameDataType.

Returns: pointer to a newly allocated OpcUa_AliasNameDataType.

void UaAliasNameDataType::copyTo ( OpcUa_AliasNameDataType * pDst ) const

Copy UaAliasNameDataType data to an existing OpcUa_AliasNameDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_AliasNameDataType * UaAliasNameDataType::detach ( OpcUa_AliasNameDataType * pDst )

Detaches the internal AliasNameDataType structure from this class.

This way you take over the control of freeing the AliasNameDataType data. If more than one reference exists, the data is copied to pDst instead of being detached.

Parameters

pDst	[out] Pointer to an OpcUa_AliasNameDataType structure that receives the AliasNameDataType data.

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

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

Compare two UaAliasNameDataType for inequality.

See also: operator==

Parameters

other the UaAliasNameDataType to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaAliasNameDataType to assign.

Returns: reference to itself.

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

Compare two UaAliasNameDataType for equality.

Parameters

other the UaAliasNameDataType to compare with.

Returns: true if equal, false if not.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation