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

#include <uauadpdatasetwritermessagedatatype.h>

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

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

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

	UaUadpDataSetWriterMessageDataType (OpcUa_UadpDataSetMessageContentMask dataSetMessageContentMask, OpcUa_UInt16 configuredSize, OpcUa_UInt16 networkMessageNumber, OpcUa_UInt16 dataSetOffset)
	Constructs an instance of the class UaUadpDataSetWriterMessageDataType with values provided in the constructor.

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

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

	~UaUadpDataSetWriterMessageDataType ()
	Destroys the UaUadpDataSetWriterMessageDataType object.

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

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

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

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

OpcUa_UadpDataSetWriterMessageDataType *	copy () const
	Copy UaUadpDataSetWriterMessageDataType data to a newly allocated OpcUa_UadpDataSetWriterMessageDataType. More...

void	copyTo (OpcUa_UadpDataSetWriterMessageDataType *pDst) const
	Copy UaUadpDataSetWriterMessageDataType data to an existing OpcUa_UadpDataSetWriterMessageDataType structure. More...

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

OpcUa_UadpDataSetWriterMessageDataType *	detach (OpcUa_UadpDataSetWriterMessageDataType *pDst)
	Detaches the internal UadpDataSetWriterMessageDataType structure from this class. More...

OpcUa_UadpDataSetMessageContentMask	getDataSetMessageContentMask () const
	Returns the DataSetMessageContentMask.

OpcUa_UInt16	getConfiguredSize () const
	Returns the ConfiguredSize.

OpcUa_UInt16	getNetworkMessageNumber () const
	Returns the NetworkMessageNumber.

OpcUa_UInt16	getDataSetOffset () const
	Returns the DataSetOffset.

void	setDataSetMessageContentMask (OpcUa_UadpDataSetMessageContentMask dataSetMessageContentMask)
	Sets the DataSetMessageContentMask.

void	setConfiguredSize (OpcUa_UInt16 configuredSize)
	Sets the ConfiguredSize.

void	setNetworkMessageNumber (OpcUa_UInt16 networkMessageNumber)
	Sets the NetworkMessageNumber.

void	setDataSetOffset (OpcUa_UInt16 dataSetOffset)
	Sets the DataSetOffset.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_UadpDataSetWriterMessageDataType.

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

Constructor & Destructor Documentation

UaUadpDataSetWriterMessageDataType::UaUadpDataSetWriterMessageDataType ( const UaUadpDataSetWriterMessageDataType & other )

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

Parameters

other the other UaUadpDataSetWriterMessageDataType used to initialize the object

UaUadpDataSetWriterMessageDataType::UaUadpDataSetWriterMessageDataType ( const OpcUa_UadpDataSetWriterMessageDataType & other )

Constructs an instance of the class UaUadpDataSetWriterMessageDataType with values from another OpcUa_UadpDataSetWriterMessageDataType structure.

Parameters

other the other OpcUa_UadpDataSetWriterMessageDataType used to initialize the object

UaUadpDataSetWriterMessageDataType::UaUadpDataSetWriterMessageDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the UadpDataSetWriterMessageDataType

UaUadpDataSetWriterMessageDataType::UaUadpDataSetWriterMessageDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the UadpDataSetWriterMessageDataType

Member Function Documentation

void UaUadpDataSetWriterMessageDataType::attach ( OpcUa_UadpDataSetWriterMessageDataType * pValue )

Attaches to an existing OpcUa_UadpDataSetWriterMessageDataType structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaUadpDataSetWriterMessageDataType::clear ( )

Clear the data of the UaUadpDataSetWriterMessageDataType.

OpcUa_UadpDataSetWriterMessageDataType * UaUadpDataSetWriterMessageDataType::clone ( const OpcUa_UadpDataSetWriterMessageDataType & source )

static

Copy OpcUa_UadpDataSetWriterMessageDataType data to a newly allocated OpcUa_UadpDataSetWriterMessageDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_UadpDataSetWriterMessageDataType.

void UaUadpDataSetWriterMessageDataType::cloneTo	(	const OpcUa_UadpDataSetWriterMessageDataType &	source,
		OpcUa_UadpDataSetWriterMessageDataType &	copy
	)

static

Copy OpcUa_UadpDataSetWriterMessageDataType data to an existing OpcUa_UadpDataSetWriterMessageDataType structure.

Parameters

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

OpcUa_UadpDataSetWriterMessageDataType * UaUadpDataSetWriterMessageDataType::copy ( ) const

Copy UaUadpDataSetWriterMessageDataType data to a newly allocated OpcUa_UadpDataSetWriterMessageDataType.

Returns: pointer to a newly allocated OpcUa_UadpDataSetWriterMessageDataType.

void UaUadpDataSetWriterMessageDataType::copyTo ( OpcUa_UadpDataSetWriterMessageDataType * pDst ) const

Copy UaUadpDataSetWriterMessageDataType data to an existing OpcUa_UadpDataSetWriterMessageDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_UadpDataSetWriterMessageDataType * UaUadpDataSetWriterMessageDataType::detach ( OpcUa_UadpDataSetWriterMessageDataType * pDst )

Detaches the internal UadpDataSetWriterMessageDataType structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_UadpDataSetWriterMessageDataType structure that receives the UadpDataSetWriterMessageDataType data.

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

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

Compare two UaUadpDataSetWriterMessageDataType for inequality.

See also: operator==

Parameters

other the UaUadpDataSetWriterMessageDataType to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaUadpDataSetWriterMessageDataType to assign.

Returns: reference to itself.

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

Compare two UaUadpDataSetWriterMessageDataType for equality.

Parameters

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation