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

#include <uaenumdefinitiondatatype.h>

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

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

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

	UaEnumDefinitionDataType (const UaEnumFields &fields)
	Constructs an instance of the class UaEnumDefinitionDataType with values provided in the constructor.

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

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

	~UaEnumDefinitionDataType ()
	Destroys the UaEnumDefinitionDataType object.

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

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

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

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

OpcUa_EnumDefinition *	copy () const
	Copy UaEnumDefinitionDataType data to a newly allocated OpcUa_EnumDefinition. More...

void	copyTo (OpcUa_EnumDefinition *pDst) const
	Copy UaEnumDefinitionDataType data to an existing OpcUa_EnumDefinition structure. More...

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

OpcUa_EnumDefinition *	detach (OpcUa_EnumDefinition *pDst)
	Detaches the internal EnumDefinition structure from this class. More...

void	getFields (UaEnumFields &fields) const
	Returns the Fields.

void	setFields (const UaEnumFields &fields)
	Sets the Fields.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_EnumDefinition.

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

Constructor & Destructor Documentation

UaEnumDefinitionDataType::UaEnumDefinitionDataType ( const UaEnumDefinitionDataType & other )

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

Parameters

other the other UaEnumDefinitionDataType used to initialize the object

UaEnumDefinitionDataType::UaEnumDefinitionDataType ( const OpcUa_EnumDefinition & other )

Constructs an instance of the class UaEnumDefinitionDataType with values from another OpcUa_EnumDefinition structure.

Parameters

other the other OpcUa_EnumDefinition used to initialize the object

UaEnumDefinitionDataType::UaEnumDefinitionDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the EnumDefinition

UaEnumDefinitionDataType::UaEnumDefinitionDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the EnumDefinition

Member Function Documentation

void UaEnumDefinitionDataType::attach ( OpcUa_EnumDefinition * pValue )

Attaches to an existing OpcUa_EnumDefinition structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaEnumDefinitionDataType::clear ( )

Clear the data of the UaEnumDefinitionDataType.

OpcUa_EnumDefinition * UaEnumDefinitionDataType::clone ( const OpcUa_EnumDefinition & source )

static

Copy OpcUa_EnumDefinition data to a newly allocated OpcUa_EnumDefinition.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_EnumDefinition.

void UaEnumDefinitionDataType::cloneTo	(	const OpcUa_EnumDefinition &	source,
		OpcUa_EnumDefinition &	copy
	)

static

Copy OpcUa_EnumDefinition data to an existing OpcUa_EnumDefinition structure.

Parameters

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

OpcUa_EnumDefinition * UaEnumDefinitionDataType::copy ( ) const

Copy UaEnumDefinitionDataType data to a newly allocated OpcUa_EnumDefinition.

Returns: pointer to a newly allocated OpcUa_EnumDefinition.

void UaEnumDefinitionDataType::copyTo ( OpcUa_EnumDefinition * pDst ) const

Copy UaEnumDefinitionDataType data to an existing OpcUa_EnumDefinition structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_EnumDefinition * UaEnumDefinitionDataType::detach ( OpcUa_EnumDefinition * pDst )

Detaches the internal EnumDefinition structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_EnumDefinition structure that receives the EnumDefinitionDataType data.

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

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

Compare two UaEnumDefinitionDataType for inequality.

See also: operator==

Parameters

other the UaEnumDefinitionDataType to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaEnumDefinitionDataType to assign.

Returns: reference to itself.

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

Compare two UaEnumDefinitionDataType for equality.

Parameters

other the UaEnumDefinitionDataType 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/uaenumdefinitiondatatype.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uaenumdefinitiondatatype.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation