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

#include <uasimpletypedescription.h>

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

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

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

	UaSimpleTypeDescription (const UaNodeId &dataTypeId, const UaQualifiedName &name, const UaNodeId &baseDataType, OpcUa_Byte builtInType)
	Constructs an instance of the class UaSimpleTypeDescription with values provided in the constructor.

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

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

	~UaSimpleTypeDescription ()
	Destroys the UaSimpleTypeDescription object.

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

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

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

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

OpcUa_SimpleTypeDescription *	copy () const
	Copy UaSimpleTypeDescription data to a newly allocated OpcUa_SimpleTypeDescription. More...

void	copyTo (OpcUa_SimpleTypeDescription *pDst) const
	Copy UaSimpleTypeDescription data to an existing OpcUa_SimpleTypeDescription structure. More...

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

OpcUa_SimpleTypeDescription *	detach (OpcUa_SimpleTypeDescription *pDst)
	Detaches the internal SimpleTypeDescription structure from this class. More...

UaNodeId	getDataTypeId () const
	Returns the DataTypeId.

UaQualifiedName	getName () const
	Returns the Name.

UaNodeId	getBaseDataType () const
	Returns the BaseDataType.

OpcUa_Byte	getBuiltInType () const
	Returns the BuiltInType.

void	setDataTypeId (const UaNodeId &dataTypeId)
	Sets the DataTypeId.

void	setName (const UaQualifiedName &name)
	Sets the Name.

void	setBaseDataType (const UaNodeId &baseDataType)
	Sets the BaseDataType.

void	setBuiltInType (OpcUa_Byte builtInType)
	Sets the BuiltInType.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_SimpleTypeDescription.

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

Constructor & Destructor Documentation

UaSimpleTypeDescription::UaSimpleTypeDescription ( const UaSimpleTypeDescription & other )

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

Parameters

other the other UaSimpleTypeDescription used to initialize the object

UaSimpleTypeDescription::UaSimpleTypeDescription ( const OpcUa_SimpleTypeDescription & other )

Constructs an instance of the class UaSimpleTypeDescription with values from another OpcUa_SimpleTypeDescription structure.

Parameters

other the other OpcUa_SimpleTypeDescription used to initialize the object

UaSimpleTypeDescription::UaSimpleTypeDescription ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the SimpleTypeDescription

UaSimpleTypeDescription::UaSimpleTypeDescription ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the SimpleTypeDescription

Member Function Documentation

void UaSimpleTypeDescription::attach ( OpcUa_SimpleTypeDescription * pValue )

Attaches to an existing OpcUa_SimpleTypeDescription structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaSimpleTypeDescription::clear ( )

Clear the data of the UaSimpleTypeDescription.

OpcUa_SimpleTypeDescription * UaSimpleTypeDescription::clone ( const OpcUa_SimpleTypeDescription & source )

static

Copy OpcUa_SimpleTypeDescription data to a newly allocated OpcUa_SimpleTypeDescription.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_SimpleTypeDescription.

void UaSimpleTypeDescription::cloneTo	(	const OpcUa_SimpleTypeDescription &	source,
		OpcUa_SimpleTypeDescription &	copy
	)

static

Copy OpcUa_SimpleTypeDescription data to an existing OpcUa_SimpleTypeDescription structure.

Parameters

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

OpcUa_SimpleTypeDescription * UaSimpleTypeDescription::copy ( ) const

Copy UaSimpleTypeDescription data to a newly allocated OpcUa_SimpleTypeDescription.

Returns: pointer to a newly allocated OpcUa_SimpleTypeDescription.

void UaSimpleTypeDescription::copyTo ( OpcUa_SimpleTypeDescription * pDst ) const

Copy UaSimpleTypeDescription data to an existing OpcUa_SimpleTypeDescription structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_SimpleTypeDescription * UaSimpleTypeDescription::detach ( OpcUa_SimpleTypeDescription * pDst )

Detaches the internal SimpleTypeDescription structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_SimpleTypeDescription structure that receives the SimpleTypeDescription data.

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

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

Compare two UaSimpleTypeDescription for inequality.

See also: operator==

Parameters

other the UaSimpleTypeDescription to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaSimpleTypeDescription to assign.

Returns: reference to itself.

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

Compare two UaSimpleTypeDescription for equality.

Parameters

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation