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

#include <uareadergroupdatatype.h>

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

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

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

	UaReaderGroupDataType (const UaString &name, OpcUa_Boolean enabled, OpcUa_MessageSecurityMode securityMode, const UaString &securityGroupId, const UaEndpointDescriptions &securityKeyServices, OpcUa_UInt32 maxNetworkMessageSize, const UaKeyValuePairs &groupProperties, UaExtensionObject &transportSettings, UaExtensionObject &messageSettings, const UaDataSetReaderDataTypes &dataSetReaders)
	Constructs an instance of the class UaReaderGroupDataType with values provided in the constructor.

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

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

	~UaReaderGroupDataType ()
	Destroys the UaReaderGroupDataType object.

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

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

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

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

OpcUa_ReaderGroupDataType *	copy () const
	Copy UaReaderGroupDataType data to a newly allocated OpcUa_ReaderGroupDataType. More...

void	copyTo (OpcUa_ReaderGroupDataType *pDst) const
	Copy UaReaderGroupDataType data to an existing OpcUa_ReaderGroupDataType structure. More...

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

OpcUa_ReaderGroupDataType *	detach (OpcUa_ReaderGroupDataType *pDst)
	Detaches the internal ReaderGroupDataType structure from this class. More...

UaString	getName () const
	Returns the Name.

OpcUa_Boolean	getEnabled () const
	Returns the Enabled.

OpcUa_MessageSecurityMode	getSecurityMode () const
	Returns the SecurityMode.

UaString	getSecurityGroupId () const
	Returns the SecurityGroupId.

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

OpcUa_UInt32	getMaxNetworkMessageSize () const
	Returns the MaxNetworkMessageSize.

void	getGroupProperties (UaKeyValuePairs &groupProperties) const
	Returns the GroupProperties.

UaExtensionObject	getTransportSettings () const
	Returns the TransportSettings.

UaExtensionObject	getMessageSettings () const
	Returns the MessageSettings.

void	getDataSetReaders (UaDataSetReaderDataTypes &dataSetReaders) const
	Returns the DataSetReaders.

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

void	setEnabled (OpcUa_Boolean enabled)
	Sets the Enabled.

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	setMaxNetworkMessageSize (OpcUa_UInt32 maxNetworkMessageSize)
	Sets the MaxNetworkMessageSize.

void	setGroupProperties (const UaKeyValuePairs &groupProperties)
	Sets the GroupProperties.

void	setTransportSettings (UaExtensionObject &transportSettings)
	Sets the TransportSettings.

void	setMessageSettings (UaExtensionObject &messageSettings)
	Sets the MessageSettings.

void	setDataSetReaders (const UaDataSetReaderDataTypes &dataSetReaders)
	Sets the DataSetReaders.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_ReaderGroupDataType.

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

Constructor & Destructor Documentation

UaReaderGroupDataType::UaReaderGroupDataType ( const UaReaderGroupDataType & other )

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

Parameters

other the other UaReaderGroupDataType used to initialize the object

UaReaderGroupDataType::UaReaderGroupDataType ( const OpcUa_ReaderGroupDataType & other )

Constructs an instance of the class UaReaderGroupDataType with values from another OpcUa_ReaderGroupDataType structure.

Parameters

other the other OpcUa_ReaderGroupDataType used to initialize the object

UaReaderGroupDataType::UaReaderGroupDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the ReaderGroupDataType

UaReaderGroupDataType::UaReaderGroupDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the ReaderGroupDataType

Member Function Documentation

void UaReaderGroupDataType::attach ( OpcUa_ReaderGroupDataType * pValue )

Attaches to an existing OpcUa_ReaderGroupDataType structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaReaderGroupDataType::clear ( )

Clear the data of the UaReaderGroupDataType.

OpcUa_ReaderGroupDataType * UaReaderGroupDataType::clone ( const OpcUa_ReaderGroupDataType & source )

static

Copy OpcUa_ReaderGroupDataType data to a newly allocated OpcUa_ReaderGroupDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_ReaderGroupDataType.

void UaReaderGroupDataType::cloneTo	(	const OpcUa_ReaderGroupDataType &	source,
		OpcUa_ReaderGroupDataType &	copy
	)

static

Copy OpcUa_ReaderGroupDataType data to an existing OpcUa_ReaderGroupDataType structure.

Parameters

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

OpcUa_ReaderGroupDataType * UaReaderGroupDataType::copy ( ) const

Copy UaReaderGroupDataType data to a newly allocated OpcUa_ReaderGroupDataType.

Returns: pointer to a newly allocated OpcUa_ReaderGroupDataType.

void UaReaderGroupDataType::copyTo ( OpcUa_ReaderGroupDataType * pDst ) const

Copy UaReaderGroupDataType data to an existing OpcUa_ReaderGroupDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_ReaderGroupDataType * UaReaderGroupDataType::detach ( OpcUa_ReaderGroupDataType * pDst )

Detaches the internal ReaderGroupDataType structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_ReaderGroupDataType structure that receives the ReaderGroupDataType data.

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

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

Compare two UaReaderGroupDataType for inequality.

See also: operator==

Parameters

other the UaReaderGroupDataType to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaReaderGroupDataType to assign.

Returns: reference to itself.

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

Compare two UaReaderGroupDataType for equality.

Parameters

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation