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

#include <uadatasetmetadatatype.h>

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

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

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

	UaDataSetMetaDataType (const UaStringArray &namespaces, const UaStructureDescriptions &structureDataTypes, const UaEnumDescriptions &enumDataTypes, const UaSimpleTypeDescriptions &simpleDataTypes, const UaString &name, const UaLocalizedText &description, const UaFieldMetaDatas &fields, const UaGuid &dataSetClassId, const UaConfigurationVersionDataType &configurationVersion)
	Constructs an instance of the class UaDataSetMetaDataType with values provided in the constructor.

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

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

	~UaDataSetMetaDataType ()
	Destroys the UaDataSetMetaDataType object.

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

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

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

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

OpcUa_DataSetMetaDataType *	copy () const
	Copy UaDataSetMetaDataType data to a newly allocated OpcUa_DataSetMetaDataType. More...

void	copyTo (OpcUa_DataSetMetaDataType *pDst) const
	Copy UaDataSetMetaDataType data to an existing OpcUa_DataSetMetaDataType structure. More...

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

OpcUa_DataSetMetaDataType *	detach (OpcUa_DataSetMetaDataType *pDst)
	Detaches the internal DataSetMetaDataType structure from this class. More...

void	getNamespaces (UaStringArray &namespaces) const
	Returns the Namespaces.

void	getStructureDataTypes (UaStructureDescriptions &structureDataTypes) const
	Returns the StructureDataTypes.

void	getEnumDataTypes (UaEnumDescriptions &enumDataTypes) const
	Returns the EnumDataTypes.

void	getSimpleDataTypes (UaSimpleTypeDescriptions &simpleDataTypes) const
	Returns the SimpleDataTypes.

UaString	getName () const
	Returns the Name.

UaLocalizedText	getDescription () const
	Returns the Description.

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

UaGuid	getDataSetClassId () const
	Returns the DataSetClassId.

UaConfigurationVersionDataType	getConfigurationVersion () const
	Returns the ConfigurationVersion.

void	setNamespaces (const UaStringArray &namespaces)
	Sets the Namespaces.

void	setStructureDataTypes (const UaStructureDescriptions &structureDataTypes)
	Sets the StructureDataTypes.

void	setEnumDataTypes (const UaEnumDescriptions &enumDataTypes)
	Sets the EnumDataTypes.

void	setSimpleDataTypes (const UaSimpleTypeDescriptions &simpleDataTypes)
	Sets the SimpleDataTypes.

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

void	setDescription (const UaLocalizedText &description)
	Sets the Description.

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

void	setDataSetClassId (const UaGuid &dataSetClassId)
	Sets the DataSetClassId.

void	setConfigurationVersion (const UaConfigurationVersionDataType &configurationVersion)
	Sets the ConfigurationVersion.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_DataSetMetaDataType.

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

Constructor & Destructor Documentation

UaDataSetMetaDataType::UaDataSetMetaDataType ( const UaDataSetMetaDataType & other )

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

Parameters

other the other UaDataSetMetaDataType used to initialize the object

UaDataSetMetaDataType::UaDataSetMetaDataType ( const OpcUa_DataSetMetaDataType & other )

Constructs an instance of the class UaDataSetMetaDataType with values from another OpcUa_DataSetMetaDataType structure.

Parameters

other the other OpcUa_DataSetMetaDataType used to initialize the object

UaDataSetMetaDataType::UaDataSetMetaDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the DataSetMetaDataType

UaDataSetMetaDataType::UaDataSetMetaDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the DataSetMetaDataType

Member Function Documentation

void UaDataSetMetaDataType::attach ( OpcUa_DataSetMetaDataType * pValue )

Attaches to an existing OpcUa_DataSetMetaDataType structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaDataSetMetaDataType::clear ( )

Clear the data of the UaDataSetMetaDataType.

OpcUa_DataSetMetaDataType * UaDataSetMetaDataType::clone ( const OpcUa_DataSetMetaDataType & source )

static

Copy OpcUa_DataSetMetaDataType data to a newly allocated OpcUa_DataSetMetaDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_DataSetMetaDataType.

void UaDataSetMetaDataType::cloneTo	(	const OpcUa_DataSetMetaDataType &	source,
		OpcUa_DataSetMetaDataType &	copy
	)

static

Copy OpcUa_DataSetMetaDataType data to an existing OpcUa_DataSetMetaDataType structure.

Parameters

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

OpcUa_DataSetMetaDataType * UaDataSetMetaDataType::copy ( ) const

Copy UaDataSetMetaDataType data to a newly allocated OpcUa_DataSetMetaDataType.

Returns: pointer to a newly allocated OpcUa_DataSetMetaDataType.

void UaDataSetMetaDataType::copyTo ( OpcUa_DataSetMetaDataType * pDst ) const

Copy UaDataSetMetaDataType data to an existing OpcUa_DataSetMetaDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_DataSetMetaDataType * UaDataSetMetaDataType::detach ( OpcUa_DataSetMetaDataType * pDst )

Detaches the internal DataSetMetaDataType structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_DataSetMetaDataType structure that receives the DataSetMetaDataType data.

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

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

Compare two UaDataSetMetaDataType for inequality.

See also: operator==

Parameters

other the UaDataSetMetaDataType to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaDataSetMetaDataType to assign.

Returns: reference to itself.

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

Compare two UaDataSetMetaDataType for equality.

Parameters

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation