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

#include <uauadpdatasetreadermessagedatatype.h>

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

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

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

	UaUadpDataSetReaderMessageDataType (OpcUa_UInt32 groupVersion, OpcUa_UInt16 networkMessageNumber, OpcUa_UInt16 dataSetOffset, const UaGuid &dataSetClassId, OpcUa_UadpNetworkMessageContentMask networkMessageContentMask, OpcUa_UadpDataSetMessageContentMask dataSetMessageContentMask, OpcUa_Double publishingInterval, OpcUa_Double receiveOffset, OpcUa_Double processingOffset)
	Constructs an instance of the class UaUadpDataSetReaderMessageDataType with values provided in the constructor.

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

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

	~UaUadpDataSetReaderMessageDataType ()
	Destroys the UaUadpDataSetReaderMessageDataType object.

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

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

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

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

OpcUa_UadpDataSetReaderMessageDataType *	copy () const
	Copy UaUadpDataSetReaderMessageDataType data to a newly allocated OpcUa_UadpDataSetReaderMessageDataType. More...

void	copyTo (OpcUa_UadpDataSetReaderMessageDataType *pDst) const
	Copy UaUadpDataSetReaderMessageDataType data to an existing OpcUa_UadpDataSetReaderMessageDataType structure. More...

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

OpcUa_UadpDataSetReaderMessageDataType *	detach (OpcUa_UadpDataSetReaderMessageDataType *pDst)
	Detaches the internal UadpDataSetReaderMessageDataType structure from this class. More...

OpcUa_UInt32	getGroupVersion () const
	Returns the GroupVersion.

OpcUa_UInt16	getNetworkMessageNumber () const
	Returns the NetworkMessageNumber.

OpcUa_UInt16	getDataSetOffset () const
	Returns the DataSetOffset.

UaGuid	getDataSetClassId () const
	Returns the DataSetClassId.

OpcUa_UadpNetworkMessageContentMask	getNetworkMessageContentMask () const
	Returns the NetworkMessageContentMask.

OpcUa_UadpDataSetMessageContentMask	getDataSetMessageContentMask () const
	Returns the DataSetMessageContentMask.

OpcUa_Double	getPublishingInterval () const
	Returns the PublishingInterval.

OpcUa_Double	getReceiveOffset () const
	Returns the ReceiveOffset.

OpcUa_Double	getProcessingOffset () const
	Returns the ProcessingOffset.

void	setGroupVersion (OpcUa_UInt32 groupVersion)
	Sets the GroupVersion.

void	setNetworkMessageNumber (OpcUa_UInt16 networkMessageNumber)
	Sets the NetworkMessageNumber.

void	setDataSetOffset (OpcUa_UInt16 dataSetOffset)
	Sets the DataSetOffset.

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

void	setNetworkMessageContentMask (OpcUa_UadpNetworkMessageContentMask networkMessageContentMask)
	Sets the NetworkMessageContentMask.

void	setDataSetMessageContentMask (OpcUa_UadpDataSetMessageContentMask dataSetMessageContentMask)
	Sets the DataSetMessageContentMask.

void	setPublishingInterval (OpcUa_Double publishingInterval)
	Sets the PublishingInterval.

void	setReceiveOffset (OpcUa_Double receiveOffset)
	Sets the ReceiveOffset.

void	setProcessingOffset (OpcUa_Double processingOffset)
	Sets the ProcessingOffset.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_UadpDataSetReaderMessageDataType.

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

Constructor & Destructor Documentation

UaUadpDataSetReaderMessageDataType::UaUadpDataSetReaderMessageDataType ( const UaUadpDataSetReaderMessageDataType & other )

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

Parameters

other the other UaUadpDataSetReaderMessageDataType used to initialize the object

UaUadpDataSetReaderMessageDataType::UaUadpDataSetReaderMessageDataType ( const OpcUa_UadpDataSetReaderMessageDataType & other )

Constructs an instance of the class UaUadpDataSetReaderMessageDataType with values from another OpcUa_UadpDataSetReaderMessageDataType structure.

Parameters

other the other OpcUa_UadpDataSetReaderMessageDataType used to initialize the object

UaUadpDataSetReaderMessageDataType::UaUadpDataSetReaderMessageDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the UadpDataSetReaderMessageDataType

UaUadpDataSetReaderMessageDataType::UaUadpDataSetReaderMessageDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the UadpDataSetReaderMessageDataType

Member Function Documentation

void UaUadpDataSetReaderMessageDataType::attach ( OpcUa_UadpDataSetReaderMessageDataType * pValue )

Attaches to an existing OpcUa_UadpDataSetReaderMessageDataType structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaUadpDataSetReaderMessageDataType::clear ( )

Clear the data of the UaUadpDataSetReaderMessageDataType.

OpcUa_UadpDataSetReaderMessageDataType * UaUadpDataSetReaderMessageDataType::clone ( const OpcUa_UadpDataSetReaderMessageDataType & source )

static

Copy OpcUa_UadpDataSetReaderMessageDataType data to a newly allocated OpcUa_UadpDataSetReaderMessageDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_UadpDataSetReaderMessageDataType.

void UaUadpDataSetReaderMessageDataType::cloneTo	(	const OpcUa_UadpDataSetReaderMessageDataType &	source,
		OpcUa_UadpDataSetReaderMessageDataType &	copy
	)

static

Copy OpcUa_UadpDataSetReaderMessageDataType data to an existing OpcUa_UadpDataSetReaderMessageDataType structure.

Parameters

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

OpcUa_UadpDataSetReaderMessageDataType * UaUadpDataSetReaderMessageDataType::copy ( ) const

Copy UaUadpDataSetReaderMessageDataType data to a newly allocated OpcUa_UadpDataSetReaderMessageDataType.

Returns: pointer to a newly allocated OpcUa_UadpDataSetReaderMessageDataType.

void UaUadpDataSetReaderMessageDataType::copyTo ( OpcUa_UadpDataSetReaderMessageDataType * pDst ) const

Copy UaUadpDataSetReaderMessageDataType data to an existing OpcUa_UadpDataSetReaderMessageDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_UadpDataSetReaderMessageDataType * UaUadpDataSetReaderMessageDataType::detach ( OpcUa_UadpDataSetReaderMessageDataType * pDst )

Detaches the internal UadpDataSetReaderMessageDataType structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_UadpDataSetReaderMessageDataType structure that receives the UadpDataSetReaderMessageDataType data.

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

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

Compare two UaUadpDataSetReaderMessageDataType for inequality.

See also: operator==

Parameters

other the UaUadpDataSetReaderMessageDataType to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaUadpDataSetReaderMessageDataType to assign.

Returns: reference to itself.

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

Compare two UaUadpDataSetReaderMessageDataType for equality.

Parameters

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation