C++ Based OPC UA Client/Server/PubSub SDK  1.7.4.520
UaNetworkAddressUrlDataType Class Reference

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

#include <uanetworkaddressurldatatype.h>

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_NetworkAddressUrlDataType.

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

Constructor & Destructor Documentation

UaNetworkAddressUrlDataType::UaNetworkAddressUrlDataType ( const UaNetworkAddressUrlDataType other)

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

Parameters
otherthe other UaNetworkAddressUrlDataType used to initialize the object
UaNetworkAddressUrlDataType::UaNetworkAddressUrlDataType ( const OpcUa_NetworkAddressUrlDataType &  other)

Constructs an instance of the class UaNetworkAddressUrlDataType with values from another OpcUa_NetworkAddressUrlDataType structure.

Parameters
otherthe other OpcUa_NetworkAddressUrlDataType used to initialize the object
UaNetworkAddressUrlDataType::UaNetworkAddressUrlDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the NetworkAddressUrlDataType
UaNetworkAddressUrlDataType::UaNetworkAddressUrlDataType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the NetworkAddressUrlDataType

Member Function Documentation

void UaNetworkAddressUrlDataType::attach ( OpcUa_NetworkAddressUrlDataType *  pValue)

Attaches to an existing OpcUa_NetworkAddressUrlDataType structure.

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

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

Clear the data of the UaNetworkAddressUrlDataType.

OpcUa_NetworkAddressUrlDataType * UaNetworkAddressUrlDataType::clone ( const OpcUa_NetworkAddressUrlDataType &  source)
static

Copy OpcUa_NetworkAddressUrlDataType data to a newly allocated OpcUa_NetworkAddressUrlDataType.

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

Copy OpcUa_NetworkAddressUrlDataType data to an existing OpcUa_NetworkAddressUrlDataType structure.

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

Copy UaNetworkAddressUrlDataType data to a newly allocated OpcUa_NetworkAddressUrlDataType.

Returns
pointer to a newly allocated OpcUa_NetworkAddressUrlDataType.
void UaNetworkAddressUrlDataType::copyTo ( OpcUa_NetworkAddressUrlDataType *  pDst) const

Copy UaNetworkAddressUrlDataType data to an existing OpcUa_NetworkAddressUrlDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_NetworkAddressUrlDataType * UaNetworkAddressUrlDataType::detach ( OpcUa_NetworkAddressUrlDataType *  pDst)

Detaches the internal NetworkAddressUrlDataType structure from this class.

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

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

Compare two UaNetworkAddressUrlDataType for inequality.

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

Assignment operator.

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

Compare two UaNetworkAddressUrlDataType for equality.

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

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