UA Server SDK C++ Bundle  1.4.1.271
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
UaNetworkGroupDataType Class Reference

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 if they are similar. More...
 
bool operator!= (const UaNetworkGroupDataType &other) const
 Returns true if the other UaNetworkGroupDataType is not equal to this. More...
 
UaNetworkGroupDataTypeoperator= (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 the data of the parameter pValue. More...
 
OpcUa_NetworkGroupDataType * detach (OpcUa_NetworkGroupDataType *pDst)
 Detaches the internal NetworkGroupDataType structure from this class. 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.

Constructor & Destructor Documentation

UaNetworkGroupDataType::UaNetworkGroupDataType ( const UaNetworkGroupDataType other)

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

Parameters
otherthe 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
otherthe 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
extensionObjectthe 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
extensionObjectthe extension object containing the NetworkGroupDataType

Member Function Documentation

void UaNetworkGroupDataType::attach ( OpcUa_NetworkGroupDataType *  pValue)

Attaches the data of the parameter pValue.

Don't clear the data of pValue afterwards manually, because UaNetworkGroupDataType is responsible for it now.

Parameters
[in]pValueParameter 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
sourceSource to clone.
Returns
new copy.
void UaNetworkGroupDataType::cloneTo ( const OpcUa_NetworkGroupDataType &  source,
OpcUa_NetworkGroupDataType &  copy 
)
static

Copy OpcUa_NetworkGroupDataType data to an existing OpcUa_NetworkGroupDataType structure.

Parameters
sourcethe source of the clone operation.
copythe destination of the clone operation.
OpcUa_NetworkGroupDataType * UaNetworkGroupDataType::copy ( ) const

Copy UaNetworkGroupDataType data to a newly allocated OpcUa_NetworkGroupDataType.

Returns
data to a newly allocated OpcUa_NetworkGroupDataType.
void UaNetworkGroupDataType::copyTo ( OpcUa_NetworkGroupDataType *  pDst) const

Copy UaNetworkGroupDataType data to an existing OpcUa_NetworkGroupDataType structure.

Parameters
pDstthe 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 releasing the NetworkGroupDataType data. If more than one reference exists, the data is copied to pDst instead of being detached.

Returns
If the function succeeds, pDst is returned, otherwise 0 is returned.
Parameters
[out]pDstPointer to OpcUa_NetworkGroupDataType structure that receives the NetworkGroupDataType data.
bool UaNetworkGroupDataType::operator!= ( const UaNetworkGroupDataType other) const

Returns true if the other UaNetworkGroupDataType is not equal to this.

See Also
operator==
Parameters
otherthe UaNetworkGroupDataType to compare.
Returns
true if other is not equal to this.
UaNetworkGroupDataType & UaNetworkGroupDataType::operator= ( const UaNetworkGroupDataType other)

Assignment operator.

Parameters
otherthe UaNetworkGroupDataType to assign.
Returns
Assignment operator.
bool UaNetworkGroupDataType::operator== ( const UaNetworkGroupDataType other) const

Compare two UaNetworkGroupDataType if they are similar.

Parameters
otherthe UaNetworkGroupDataType to compare.
Returns
true if similar, false if not.

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