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

#include <uapublisheddatasetdatatype.h>

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

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

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

	UaPublishedDataSetDataType (const UaString &name, const UaStringArray &dataSetFolder, const UaDataSetMetaDataType &dataSetMetaData, const UaKeyValuePairs &extensionFields, UaExtensionObject &dataSetSource)
	Constructs an instance of the class UaPublishedDataSetDataType with values provided in the constructor.

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

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

	~UaPublishedDataSetDataType ()
	Destroys the UaPublishedDataSetDataType object.

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

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

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

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

OpcUa_PublishedDataSetDataType *	copy () const
	Copy UaPublishedDataSetDataType data to a newly allocated OpcUa_PublishedDataSetDataType. More...

void	copyTo (OpcUa_PublishedDataSetDataType *pDst) const
	Copy UaPublishedDataSetDataType data to an existing OpcUa_PublishedDataSetDataType structure. More...

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

OpcUa_PublishedDataSetDataType *	detach (OpcUa_PublishedDataSetDataType *pDst)
	Detaches the internal PublishedDataSetDataType structure from this class. More...

UaString	getName () const
	Returns the Name.

void	getDataSetFolder (UaStringArray &dataSetFolder) const
	Returns the DataSetFolder.

UaDataSetMetaDataType	getDataSetMetaData () const
	Returns the DataSetMetaData.

void	getExtensionFields (UaKeyValuePairs &extensionFields) const
	Returns the ExtensionFields.

UaExtensionObject	getDataSetSource () const
	Returns the DataSetSource.

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

void	setDataSetFolder (const UaStringArray &dataSetFolder)
	Sets the DataSetFolder.

void	setDataSetMetaData (const UaDataSetMetaDataType &dataSetMetaData)
	Sets the DataSetMetaData.

void	setExtensionFields (const UaKeyValuePairs &extensionFields)
	Sets the ExtensionFields.

void	setDataSetSource (UaExtensionObject &dataSetSource)
	Sets the DataSetSource.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_PublishedDataSetDataType.

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

Constructor & Destructor Documentation

UaPublishedDataSetDataType::UaPublishedDataSetDataType ( const UaPublishedDataSetDataType & other )

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

Parameters

other the other UaPublishedDataSetDataType used to initialize the object

UaPublishedDataSetDataType::UaPublishedDataSetDataType ( const OpcUa_PublishedDataSetDataType & other )

Constructs an instance of the class UaPublishedDataSetDataType with values from another OpcUa_PublishedDataSetDataType structure.

Parameters

other the other OpcUa_PublishedDataSetDataType used to initialize the object

UaPublishedDataSetDataType::UaPublishedDataSetDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the PublishedDataSetDataType

UaPublishedDataSetDataType::UaPublishedDataSetDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the PublishedDataSetDataType

Member Function Documentation

void UaPublishedDataSetDataType::attach ( OpcUa_PublishedDataSetDataType * pValue )

Attaches to an existing OpcUa_PublishedDataSetDataType structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaPublishedDataSetDataType::clear ( )

Clear the data of the UaPublishedDataSetDataType.

OpcUa_PublishedDataSetDataType * UaPublishedDataSetDataType::clone ( const OpcUa_PublishedDataSetDataType & source )

static

Copy OpcUa_PublishedDataSetDataType data to a newly allocated OpcUa_PublishedDataSetDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_PublishedDataSetDataType.

void UaPublishedDataSetDataType::cloneTo	(	const OpcUa_PublishedDataSetDataType &	source,
		OpcUa_PublishedDataSetDataType &	copy
	)

static

Copy OpcUa_PublishedDataSetDataType data to an existing OpcUa_PublishedDataSetDataType structure.

Parameters

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

OpcUa_PublishedDataSetDataType * UaPublishedDataSetDataType::copy ( ) const

Copy UaPublishedDataSetDataType data to a newly allocated OpcUa_PublishedDataSetDataType.

Returns: pointer to a newly allocated OpcUa_PublishedDataSetDataType.

void UaPublishedDataSetDataType::copyTo ( OpcUa_PublishedDataSetDataType * pDst ) const

Copy UaPublishedDataSetDataType data to an existing OpcUa_PublishedDataSetDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_PublishedDataSetDataType * UaPublishedDataSetDataType::detach ( OpcUa_PublishedDataSetDataType * pDst )

Detaches the internal PublishedDataSetDataType structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_PublishedDataSetDataType structure that receives the PublishedDataSetDataType data.

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

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

Compare two UaPublishedDataSetDataType for inequality.

See also: operator==

Parameters

other the UaPublishedDataSetDataType to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaPublishedDataSetDataType to assign.

Returns: reference to itself.

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

Compare two UaPublishedDataSetDataType for equality.

Parameters

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation