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

#include <uanetworkgroupdatatype.h>

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

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

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

	UaNetworkGroupDataType (const UaString &serverUri, const UaEndpointUrlListDataTypes &networkPaths)
	Constructs an instance of the class UaNetworkGroupDataType with values provided in the constructor.

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

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

	~UaNetworkGroupDataType ()
	Destroys the UaNetworkGroupDataType object.

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

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

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

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

OpcUa_NetworkGroupDataType *	copy () const
	Copy UaNetworkGroupDataType data to a newly allocated OpcUa_NetworkGroupDataType. More...

void	copyTo (OpcUa_NetworkGroupDataType *pDst) const
	Copy UaNetworkGroupDataType data to an existing OpcUa_NetworkGroupDataType structure. More...

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

OpcUa_NetworkGroupDataType *	detach (OpcUa_NetworkGroupDataType *pDst)
	Detaches the internal NetworkGroupDataType structure from this class. More...

UaString	getServerUri () const
	URI of the Server represented by the network group.

void	getNetworkPaths (UaEndpointUrlListDataTypes &networkPaths) const
	Array of different network paths to the server, for example provided by different network cards in a Server node. More...

void	setServerUri (const UaString &serverUri)
	URI of the Server represented by the network group.

void	setNetworkPaths (const UaEndpointUrlListDataTypes &networkPaths)
	Array of different network paths to the server, for example provided by different network cards in a Server node. More...

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_NetworkGroupDataType.

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

Contains information on different network paths for one Server.

Constructor & Destructor Documentation

UaNetworkGroupDataType::UaNetworkGroupDataType ( const UaNetworkGroupDataType & other )

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

Parameters

other the other UaNetworkGroupDataType used to initialize the object

UaNetworkGroupDataType::UaNetworkGroupDataType ( const OpcUa_NetworkGroupDataType & other )

Constructs an instance of the class UaNetworkGroupDataType with values from another OpcUa_NetworkGroupDataType structure.

Parameters

other the other OpcUa_NetworkGroupDataType used to initialize the object

UaNetworkGroupDataType::UaNetworkGroupDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the NetworkGroupDataType

UaNetworkGroupDataType::UaNetworkGroupDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the NetworkGroupDataType

Member Function Documentation

void UaNetworkGroupDataType::attach ( OpcUa_NetworkGroupDataType * pValue )

Attaches to an existing OpcUa_NetworkGroupDataType structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaNetworkGroupDataType::clear ( )

Clear the data of the UaNetworkGroupDataType.

OpcUa_NetworkGroupDataType * UaNetworkGroupDataType::clone ( const OpcUa_NetworkGroupDataType & source )

static

Copy OpcUa_NetworkGroupDataType data to a newly allocated OpcUa_NetworkGroupDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_NetworkGroupDataType.

void UaNetworkGroupDataType::cloneTo	(	const OpcUa_NetworkGroupDataType &	source,
		OpcUa_NetworkGroupDataType &	copy
	)

static

Copy OpcUa_NetworkGroupDataType data to an existing OpcUa_NetworkGroupDataType structure.

Parameters

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

OpcUa_NetworkGroupDataType * UaNetworkGroupDataType::copy ( ) const

Copy UaNetworkGroupDataType data to a newly allocated OpcUa_NetworkGroupDataType.

Returns: pointer to a newly allocated OpcUa_NetworkGroupDataType.

void UaNetworkGroupDataType::copyTo ( OpcUa_NetworkGroupDataType * pDst ) const

Copy UaNetworkGroupDataType data to an existing OpcUa_NetworkGroupDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_NetworkGroupDataType * UaNetworkGroupDataType::detach ( OpcUa_NetworkGroupDataType * pDst )

Detaches the internal NetworkGroupDataType structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_NetworkGroupDataType structure that receives the NetworkGroupDataType data.

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

void UaNetworkGroupDataType::getNetworkPaths ( UaEndpointUrlListDataTypes & networkPaths ) const

Array of different network paths to the server, for example provided by different network cards in a Server node.

Each network path can have several Endpoints representing different protocol options for the same path.

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

Compare two UaNetworkGroupDataType for inequality.

See also: operator==

Parameters

other the UaNetworkGroupDataType to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaNetworkGroupDataType to assign.

Returns: reference to itself.

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

Compare two UaNetworkGroupDataType for equality.

Parameters

other the UaNetworkGroupDataType to compare with.

Returns: true if equal, false if not.

void UaNetworkGroupDataType::setNetworkPaths ( const UaEndpointUrlListDataTypes & networkPaths )

Array of different network paths to the server, for example provided by different network cards in a Server node.

Each network path can have several Endpoints representing different protocol options for the same path.

The documentation for this class was generated from the following files:

C:/work/uasdkcpp/src/uabase/uabasecpp/uanetworkgroupdatatype.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uanetworkgroupdatatype.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation