C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537

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

#include <uanetworkaddressdatatype.h>

Public Member Functions

 UaNetworkAddressDataType ()
 Constructs an instance of the class UaNetworkAddressDataType with empty default values.
 
 UaNetworkAddressDataType (const UaNetworkAddressDataType &other)
 Constructs an instance of the class UaNetworkAddressDataType with values from another UaNetworkAddressDataType object. More...
 
 UaNetworkAddressDataType (const OpcUa_NetworkAddressDataType &other)
 Constructs an instance of the class UaNetworkAddressDataType with values from another OpcUa_NetworkAddressDataType structure. More...
 
 UaNetworkAddressDataType (const UaString &networkInterface)
 Constructs an instance of the class UaNetworkAddressDataType with values provided in the constructor.
 
 UaNetworkAddressDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaNetworkAddressDataType initialized with value from a UaExtensionObject. More...
 
 UaNetworkAddressDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaNetworkAddressDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaNetworkAddressDataType ()
 Destroys the UaNetworkAddressDataType object.
 
void clear ()
 Clear the data of the UaNetworkAddressDataType. More...
 
bool operator== (const UaNetworkAddressDataType &other) const
 Compare two UaNetworkAddressDataType for equality. More...
 
bool operator!= (const UaNetworkAddressDataType &other) const
 Compare two UaNetworkAddressDataType for inequality. More...
 
UaNetworkAddressDataTypeoperator= (const UaNetworkAddressDataType &other)
 Assignment operator. More...
 
OpcUa_NetworkAddressDataType * copy () const
 Copy UaNetworkAddressDataType data to a newly allocated OpcUa_NetworkAddressDataType. More...
 
void copyTo (OpcUa_NetworkAddressDataType *pDst) const
 Copy UaNetworkAddressDataType data to an existing OpcUa_NetworkAddressDataType structure. More...
 
void attach (OpcUa_NetworkAddressDataType *pValue)
 Attaches to an existing OpcUa_NetworkAddressDataType structure. More...
 
OpcUa_NetworkAddressDataType * detach (OpcUa_NetworkAddressDataType *pDst)
 Detaches the internal NetworkAddressDataType structure from this class. More...
 
UaString getNetworkInterface () const
 Returns the NetworkInterface.
 
void setNetworkInterface (const UaString &networkInterface)
 Sets the NetworkInterface.
 

Static Public Member Functions

static
OpcUa_NetworkAddressDataType * 
clone (const OpcUa_NetworkAddressDataType &source)
 Copy OpcUa_NetworkAddressDataType data to a newly allocated OpcUa_NetworkAddressDataType. More...
 
static void cloneTo (const OpcUa_NetworkAddressDataType &source, OpcUa_NetworkAddressDataType &copy)
 Copy OpcUa_NetworkAddressDataType data to an existing OpcUa_NetworkAddressDataType structure. More...
 

Detailed Description

Wrapper class for the UA stack structure OpcUa_NetworkAddressDataType.

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

Constructor & Destructor Documentation

UaNetworkAddressDataType::UaNetworkAddressDataType ( const UaNetworkAddressDataType other)

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

Parameters
otherthe other UaNetworkAddressDataType used to initialize the object
UaNetworkAddressDataType::UaNetworkAddressDataType ( const OpcUa_NetworkAddressDataType &  other)

Constructs an instance of the class UaNetworkAddressDataType with values from another OpcUa_NetworkAddressDataType structure.

Parameters
otherthe other OpcUa_NetworkAddressDataType used to initialize the object
UaNetworkAddressDataType::UaNetworkAddressDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the NetworkAddressDataType
UaNetworkAddressDataType::UaNetworkAddressDataType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the NetworkAddressDataType

Member Function Documentation

void UaNetworkAddressDataType::attach ( OpcUa_NetworkAddressDataType *  pValue)

Attaches to an existing OpcUa_NetworkAddressDataType structure.

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

Parameters
pValue[in] Parameter to attach to.
void UaNetworkAddressDataType::clear ( )

Clear the data of the UaNetworkAddressDataType.

OpcUa_NetworkAddressDataType * UaNetworkAddressDataType::clone ( const OpcUa_NetworkAddressDataType &  source)
static

Copy OpcUa_NetworkAddressDataType data to a newly allocated OpcUa_NetworkAddressDataType.

Parameters
sourceSource to clone.
Returns
pointer to a newly allocated OpcUa_NetworkAddressDataType.
void UaNetworkAddressDataType::cloneTo ( const OpcUa_NetworkAddressDataType &  source,
OpcUa_NetworkAddressDataType &  copy 
)
static

Copy OpcUa_NetworkAddressDataType data to an existing OpcUa_NetworkAddressDataType structure.

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

Copy UaNetworkAddressDataType data to a newly allocated OpcUa_NetworkAddressDataType.

Returns
pointer to a newly allocated OpcUa_NetworkAddressDataType.
void UaNetworkAddressDataType::copyTo ( OpcUa_NetworkAddressDataType *  pDst) const

Copy UaNetworkAddressDataType data to an existing OpcUa_NetworkAddressDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_NetworkAddressDataType * UaNetworkAddressDataType::detach ( OpcUa_NetworkAddressDataType *  pDst)

Detaches the internal NetworkAddressDataType structure from this class.

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

Parameters
pDst[out] Pointer to an OpcUa_NetworkAddressDataType structure that receives the NetworkAddressDataType data.
Returns
If the function succeeds, pDst is returned, otherwise 0 is returned.
bool UaNetworkAddressDataType::operator!= ( const UaNetworkAddressDataType other) const

Compare two UaNetworkAddressDataType for inequality.

See also
operator==
Parameters
otherthe UaNetworkAddressDataType to compare with.
Returns
true if not equal, false otherwise.
UaNetworkAddressDataType & UaNetworkAddressDataType::operator= ( const UaNetworkAddressDataType other)

Assignment operator.

Parameters
otherthe UaNetworkAddressDataType to assign.
Returns
reference to itself.
bool UaNetworkAddressDataType::operator== ( const UaNetworkAddressDataType other) const

Compare two UaNetworkAddressDataType for equality.

Parameters
otherthe UaNetworkAddressDataType to compare with.
Returns
true if equal, false if not.

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