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

#include <uadatasetwriterdatatype.h>

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

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

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

	UaDataSetWriterDataType (const UaString &name, OpcUa_Boolean enabled, OpcUa_UInt16 dataSetWriterId, OpcUa_DataSetFieldContentMask dataSetFieldContentMask, OpcUa_UInt32 keyFrameCount, const UaString &dataSetName, const UaKeyValuePairs &dataSetWriterProperties, UaExtensionObject &transportSettings, UaExtensionObject &messageSettings)
	Constructs an instance of the class UaDataSetWriterDataType with values provided in the constructor.

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

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

	~UaDataSetWriterDataType ()
	Destroys the UaDataSetWriterDataType object.

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

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

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

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

OpcUa_DataSetWriterDataType *	copy () const
	Copy UaDataSetWriterDataType data to a newly allocated OpcUa_DataSetWriterDataType. More...

void	copyTo (OpcUa_DataSetWriterDataType *pDst) const
	Copy UaDataSetWriterDataType data to an existing OpcUa_DataSetWriterDataType structure. More...

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

OpcUa_DataSetWriterDataType *	detach (OpcUa_DataSetWriterDataType *pDst)
	Detaches the internal DataSetWriterDataType structure from this class. More...

UaString	getName () const
	Returns the Name.

OpcUa_Boolean	getEnabled () const
	Returns the Enabled.

OpcUa_UInt16	getDataSetWriterId () const
	Returns the DataSetWriterId.

OpcUa_DataSetFieldContentMask	getDataSetFieldContentMask () const
	Returns the DataSetFieldContentMask.

OpcUa_UInt32	getKeyFrameCount () const
	Returns the KeyFrameCount.

UaString	getDataSetName () const
	Returns the DataSetName.

void	getDataSetWriterProperties (UaKeyValuePairs &dataSetWriterProperties) const
	Returns the DataSetWriterProperties.

UaExtensionObject	getTransportSettings () const
	Returns the TransportSettings.

UaExtensionObject	getMessageSettings () const
	Returns the MessageSettings.

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

void	setEnabled (OpcUa_Boolean enabled)
	Sets the Enabled.

void	setDataSetWriterId (OpcUa_UInt16 dataSetWriterId)
	Sets the DataSetWriterId.

void	setDataSetFieldContentMask (OpcUa_DataSetFieldContentMask dataSetFieldContentMask)
	Sets the DataSetFieldContentMask.

void	setKeyFrameCount (OpcUa_UInt32 keyFrameCount)
	Sets the KeyFrameCount.

void	setDataSetName (const UaString &dataSetName)
	Sets the DataSetName.

void	setDataSetWriterProperties (const UaKeyValuePairs &dataSetWriterProperties)
	Sets the DataSetWriterProperties.

void	setTransportSettings (UaExtensionObject &transportSettings)
	Sets the TransportSettings.

void	setMessageSettings (UaExtensionObject &messageSettings)
	Sets the MessageSettings.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_DataSetWriterDataType.

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

Constructor & Destructor Documentation

UaDataSetWriterDataType::UaDataSetWriterDataType ( const UaDataSetWriterDataType & other )

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

Parameters

other the other UaDataSetWriterDataType used to initialize the object

UaDataSetWriterDataType::UaDataSetWriterDataType ( const OpcUa_DataSetWriterDataType & other )

Constructs an instance of the class UaDataSetWriterDataType with values from another OpcUa_DataSetWriterDataType structure.

Parameters

other the other OpcUa_DataSetWriterDataType used to initialize the object

UaDataSetWriterDataType::UaDataSetWriterDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the DataSetWriterDataType

UaDataSetWriterDataType::UaDataSetWriterDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the DataSetWriterDataType

Member Function Documentation

void UaDataSetWriterDataType::attach ( OpcUa_DataSetWriterDataType * pValue )

Attaches to an existing OpcUa_DataSetWriterDataType structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaDataSetWriterDataType::clear ( )

Clear the data of the UaDataSetWriterDataType.

OpcUa_DataSetWriterDataType * UaDataSetWriterDataType::clone ( const OpcUa_DataSetWriterDataType & source )

static

Copy OpcUa_DataSetWriterDataType data to a newly allocated OpcUa_DataSetWriterDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_DataSetWriterDataType.

void UaDataSetWriterDataType::cloneTo	(	const OpcUa_DataSetWriterDataType &	source,
		OpcUa_DataSetWriterDataType &	copy
	)

static

Copy OpcUa_DataSetWriterDataType data to an existing OpcUa_DataSetWriterDataType structure.

Parameters

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

OpcUa_DataSetWriterDataType * UaDataSetWriterDataType::copy ( ) const

Copy UaDataSetWriterDataType data to a newly allocated OpcUa_DataSetWriterDataType.

Returns: pointer to a newly allocated OpcUa_DataSetWriterDataType.

void UaDataSetWriterDataType::copyTo ( OpcUa_DataSetWriterDataType * pDst ) const

Copy UaDataSetWriterDataType data to an existing OpcUa_DataSetWriterDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_DataSetWriterDataType * UaDataSetWriterDataType::detach ( OpcUa_DataSetWriterDataType * pDst )

Detaches the internal DataSetWriterDataType structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_DataSetWriterDataType structure that receives the DataSetWriterDataType data.

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

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

Compare two UaDataSetWriterDataType for inequality.

See also: operator==

Parameters

other the UaDataSetWriterDataType to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaDataSetWriterDataType to assign.

Returns: reference to itself.

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

Compare two UaDataSetWriterDataType for equality.

Parameters

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation