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

#include <uadatasetreaderdatatype.h>

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

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

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

	UaDataSetReaderDataType (const UaString &name, OpcUa_Boolean enabled, const UaVariant &publisherId, OpcUa_UInt16 writerGroupId, OpcUa_UInt16 dataSetWriterId, const UaDataSetMetaDataType &dataSetMetaData, OpcUa_DataSetFieldContentMask dataSetFieldContentMask, OpcUa_Double messageReceiveTimeout, OpcUa_UInt32 keyFrameCount, const UaString &headerLayoutUri, OpcUa_MessageSecurityMode securityMode, const UaString &securityGroupId, const UaEndpointDescriptions &securityKeyServices, const UaKeyValuePairs &dataSetReaderProperties, UaExtensionObject &transportSettings, UaExtensionObject &messageSettings, UaExtensionObject &subscribedDataSet)
	Constructs an instance of the class UaDataSetReaderDataType with values provided in the constructor.

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

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

	~UaDataSetReaderDataType ()
	Destroys the UaDataSetReaderDataType object.

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

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

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

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

OpcUa_DataSetReaderDataType *	copy () const
	Copy UaDataSetReaderDataType data to a newly allocated OpcUa_DataSetReaderDataType. More...

void	copyTo (OpcUa_DataSetReaderDataType *pDst) const
	Copy UaDataSetReaderDataType data to an existing OpcUa_DataSetReaderDataType structure. More...

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

OpcUa_DataSetReaderDataType *	detach (OpcUa_DataSetReaderDataType *pDst)
	Detaches the internal DataSetReaderDataType structure from this class. More...

UaString	getName () const
	Returns the Name.

OpcUa_Boolean	getEnabled () const
	Returns the Enabled.

UaVariant	getPublisherId () const
	Returns the PublisherId.

OpcUa_UInt16	getWriterGroupId () const
	Returns the WriterGroupId.

OpcUa_UInt16	getDataSetWriterId () const
	Returns the DataSetWriterId.

UaDataSetMetaDataType	getDataSetMetaData () const
	Returns the DataSetMetaData.

OpcUa_DataSetFieldContentMask	getDataSetFieldContentMask () const
	Returns the DataSetFieldContentMask.

OpcUa_Double	getMessageReceiveTimeout () const
	Returns the MessageReceiveTimeout.

OpcUa_UInt32	getKeyFrameCount () const
	Returns the KeyFrameCount.

UaString	getHeaderLayoutUri () const
	Returns the HeaderLayoutUri.

OpcUa_MessageSecurityMode	getSecurityMode () const
	Returns the SecurityMode.

UaString	getSecurityGroupId () const
	Returns the SecurityGroupId.

void	getSecurityKeyServices (UaEndpointDescriptions &securityKeyServices) const
	Returns the SecurityKeyServices.

void	getDataSetReaderProperties (UaKeyValuePairs &dataSetReaderProperties) const
	Returns the DataSetReaderProperties.

UaExtensionObject	getTransportSettings () const
	Returns the TransportSettings.

UaExtensionObject	getMessageSettings () const
	Returns the MessageSettings.

UaExtensionObject	getSubscribedDataSet () const
	Returns the SubscribedDataSet.

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

void	setEnabled (OpcUa_Boolean enabled)
	Sets the Enabled.

void	setPublisherId (const UaVariant &publisherId)
	Sets the PublisherId.

void	setWriterGroupId (OpcUa_UInt16 writerGroupId)
	Sets the WriterGroupId.

void	setDataSetWriterId (OpcUa_UInt16 dataSetWriterId)
	Sets the DataSetWriterId.

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

void	setDataSetFieldContentMask (OpcUa_DataSetFieldContentMask dataSetFieldContentMask)
	Sets the DataSetFieldContentMask.

void	setMessageReceiveTimeout (OpcUa_Double messageReceiveTimeout)
	Sets the MessageReceiveTimeout.

void	setKeyFrameCount (OpcUa_UInt32 keyFrameCount)
	Sets the KeyFrameCount.

void	setHeaderLayoutUri (const UaString &headerLayoutUri)
	Sets the HeaderLayoutUri.

void	setSecurityMode (OpcUa_MessageSecurityMode securityMode)
	Sets the SecurityMode.

void	setSecurityGroupId (const UaString &securityGroupId)
	Sets the SecurityGroupId.

void	setSecurityKeyServices (const UaEndpointDescriptions &securityKeyServices)
	Sets the SecurityKeyServices.

void	setDataSetReaderProperties (const UaKeyValuePairs &dataSetReaderProperties)
	Sets the DataSetReaderProperties.

void	setTransportSettings (UaExtensionObject &transportSettings)
	Sets the TransportSettings.

void	setMessageSettings (UaExtensionObject &messageSettings)
	Sets the MessageSettings.

void	setSubscribedDataSet (UaExtensionObject &subscribedDataSet)
	Sets the SubscribedDataSet.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_DataSetReaderDataType.

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

Constructor & Destructor Documentation

UaDataSetReaderDataType::UaDataSetReaderDataType ( const UaDataSetReaderDataType & other )

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

Parameters

other the other UaDataSetReaderDataType used to initialize the object

UaDataSetReaderDataType::UaDataSetReaderDataType ( const OpcUa_DataSetReaderDataType & other )

Constructs an instance of the class UaDataSetReaderDataType with values from another OpcUa_DataSetReaderDataType structure.

Parameters

other the other OpcUa_DataSetReaderDataType used to initialize the object

UaDataSetReaderDataType::UaDataSetReaderDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the DataSetReaderDataType

UaDataSetReaderDataType::UaDataSetReaderDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the DataSetReaderDataType

Member Function Documentation

void UaDataSetReaderDataType::attach ( OpcUa_DataSetReaderDataType * pValue )

Attaches to an existing OpcUa_DataSetReaderDataType structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaDataSetReaderDataType::clear ( )

Clear the data of the UaDataSetReaderDataType.

OpcUa_DataSetReaderDataType * UaDataSetReaderDataType::clone ( const OpcUa_DataSetReaderDataType & source )

static

Copy OpcUa_DataSetReaderDataType data to a newly allocated OpcUa_DataSetReaderDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_DataSetReaderDataType.

void UaDataSetReaderDataType::cloneTo	(	const OpcUa_DataSetReaderDataType &	source,
		OpcUa_DataSetReaderDataType &	copy
	)

static

Copy OpcUa_DataSetReaderDataType data to an existing OpcUa_DataSetReaderDataType structure.

Parameters

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

OpcUa_DataSetReaderDataType * UaDataSetReaderDataType::copy ( ) const

Copy UaDataSetReaderDataType data to a newly allocated OpcUa_DataSetReaderDataType.

Returns: pointer to a newly allocated OpcUa_DataSetReaderDataType.

void UaDataSetReaderDataType::copyTo ( OpcUa_DataSetReaderDataType * pDst ) const

Copy UaDataSetReaderDataType data to an existing OpcUa_DataSetReaderDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_DataSetReaderDataType * UaDataSetReaderDataType::detach ( OpcUa_DataSetReaderDataType * pDst )

Detaches the internal DataSetReaderDataType structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_DataSetReaderDataType structure that receives the DataSetReaderDataType data.

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

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

Compare two UaDataSetReaderDataType for inequality.

See also: operator==

Parameters

other the UaDataSetReaderDataType to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaDataSetReaderDataType to assign.

Returns: reference to itself.

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

Compare two UaDataSetReaderDataType for equality.

Parameters

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation