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

#include <uapubsubconfigurationdatatype.h>

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

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

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

	UaPubSubConfigurationDataType (const UaPublishedDataSetDataTypes &publishedDataSets, const UaPubSubConnectionDataTypes &connections, OpcUa_Boolean enabled)
	Constructs an instance of the class UaPubSubConfigurationDataType with values provided in the constructor.

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

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

	~UaPubSubConfigurationDataType ()
	Destroys the UaPubSubConfigurationDataType object.

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

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

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

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

OpcUa_PubSubConfigurationDataType *	copy () const
	Copy UaPubSubConfigurationDataType data to a newly allocated OpcUa_PubSubConfigurationDataType. More...

void	copyTo (OpcUa_PubSubConfigurationDataType *pDst) const
	Copy UaPubSubConfigurationDataType data to an existing OpcUa_PubSubConfigurationDataType structure. More...

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

OpcUa_PubSubConfigurationDataType *	detach (OpcUa_PubSubConfigurationDataType *pDst)
	Detaches the internal PubSubConfigurationDataType structure from this class. More...

void	getPublishedDataSets (UaPublishedDataSetDataTypes &publishedDataSets) const
	Returns the PublishedDataSets.

void	getConnections (UaPubSubConnectionDataTypes &connections) const
	Returns the Connections.

OpcUa_Boolean	getEnabled () const
	Returns the Enabled.

void	setPublishedDataSets (const UaPublishedDataSetDataTypes &publishedDataSets)
	Sets the PublishedDataSets.

void	setConnections (const UaPubSubConnectionDataTypes &connections)
	Sets the Connections.

void	setEnabled (OpcUa_Boolean enabled)
	Sets the Enabled.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_PubSubConfigurationDataType.

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

Constructor & Destructor Documentation

UaPubSubConfigurationDataType::UaPubSubConfigurationDataType ( const UaPubSubConfigurationDataType & other )

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

Parameters

other the other UaPubSubConfigurationDataType used to initialize the object

UaPubSubConfigurationDataType::UaPubSubConfigurationDataType ( const OpcUa_PubSubConfigurationDataType & other )

Constructs an instance of the class UaPubSubConfigurationDataType with values from another OpcUa_PubSubConfigurationDataType structure.

Parameters

other the other OpcUa_PubSubConfigurationDataType used to initialize the object

UaPubSubConfigurationDataType::UaPubSubConfigurationDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the PubSubConfigurationDataType

UaPubSubConfigurationDataType::UaPubSubConfigurationDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the PubSubConfigurationDataType

Member Function Documentation

void UaPubSubConfigurationDataType::attach ( OpcUa_PubSubConfigurationDataType * pValue )

Attaches to an existing OpcUa_PubSubConfigurationDataType structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaPubSubConfigurationDataType::clear ( )

Clear the data of the UaPubSubConfigurationDataType.

OpcUa_PubSubConfigurationDataType * UaPubSubConfigurationDataType::clone ( const OpcUa_PubSubConfigurationDataType & source )

static

Copy OpcUa_PubSubConfigurationDataType data to a newly allocated OpcUa_PubSubConfigurationDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_PubSubConfigurationDataType.

void UaPubSubConfigurationDataType::cloneTo	(	const OpcUa_PubSubConfigurationDataType &	source,
		OpcUa_PubSubConfigurationDataType &	copy
	)

static

Copy OpcUa_PubSubConfigurationDataType data to an existing OpcUa_PubSubConfigurationDataType structure.

Parameters

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

OpcUa_PubSubConfigurationDataType * UaPubSubConfigurationDataType::copy ( ) const

Copy UaPubSubConfigurationDataType data to a newly allocated OpcUa_PubSubConfigurationDataType.

Returns: pointer to a newly allocated OpcUa_PubSubConfigurationDataType.

void UaPubSubConfigurationDataType::copyTo ( OpcUa_PubSubConfigurationDataType * pDst ) const

Copy UaPubSubConfigurationDataType data to an existing OpcUa_PubSubConfigurationDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_PubSubConfigurationDataType * UaPubSubConfigurationDataType::detach ( OpcUa_PubSubConfigurationDataType * pDst )

Detaches the internal PubSubConfigurationDataType structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_PubSubConfigurationDataType structure that receives the PubSubConfigurationDataType data.

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

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

Compare two UaPubSubConfigurationDataType for inequality.

See also: operator==

Parameters

other the UaPubSubConfigurationDataType to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaPubSubConfigurationDataType to assign.

Returns: reference to itself.

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

Compare two UaPubSubConfigurationDataType for equality.

Parameters

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation