C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
UaEndpointUrlListDataType Class Reference

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

#include <uaendpointurllistdatatype.h>

Public Member Functions

 UaEndpointUrlListDataType ()
 Constructs an instance of the class UaEndpointUrlListDataType with empty default values.
 
 UaEndpointUrlListDataType (const UaEndpointUrlListDataType &other)
 Constructs an instance of the class UaEndpointUrlListDataType with values from another UaEndpointUrlListDataType object. More...
 
 UaEndpointUrlListDataType (const OpcUa_EndpointUrlListDataType &other)
 Constructs an instance of the class UaEndpointUrlListDataType with values from another OpcUa_EndpointUrlListDataType structure. More...
 
 UaEndpointUrlListDataType (const UaStringArray &endpointUrlList)
 Constructs an instance of the class UaEndpointUrlListDataType with values provided in the constructor.
 
 UaEndpointUrlListDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaEndpointUrlListDataType initialized with value from a UaExtensionObject. More...
 
 UaEndpointUrlListDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaEndpointUrlListDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaEndpointUrlListDataType ()
 Destroys the UaEndpointUrlListDataType object.
 
void clear ()
 Clear the data of the UaEndpointUrlListDataType. More...
 
bool operator== (const UaEndpointUrlListDataType &other) const
 Compare two UaEndpointUrlListDataType for equality. More...
 
bool operator!= (const UaEndpointUrlListDataType &other) const
 Compare two UaEndpointUrlListDataType for inequality. More...
 
UaEndpointUrlListDataTypeoperator= (const UaEndpointUrlListDataType &other)
 Assignment operator. More...
 
OpcUa_EndpointUrlListDataTypecopy () const
 Copy UaEndpointUrlListDataType data to a newly allocated OpcUa_EndpointUrlListDataType. More...
 
void copyTo (OpcUa_EndpointUrlListDataType *pDst) const
 Copy UaEndpointUrlListDataType data to an existing OpcUa_EndpointUrlListDataType structure. More...
 
void attach (OpcUa_EndpointUrlListDataType *pValue)
 Attaches to an existing OpcUa_EndpointUrlListDataType structure. More...
 
OpcUa_EndpointUrlListDataTypedetach (OpcUa_EndpointUrlListDataType *pDst)
 Detaches the internal EndpointUrlListDataType structure from this class. More...
 
void getEndpointUrlList (UaStringArray &endpointUrlList) const
 List of URLs of an Endpoint.
 
void setEndpointUrlList (const UaStringArray &endpointUrlList)
 List of URLs of an Endpoint.
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_EndpointUrlListDataType.

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

Structure representing a list of URLs of an Endpoint.

Constructor & Destructor Documentation

UaEndpointUrlListDataType::UaEndpointUrlListDataType ( const UaEndpointUrlListDataType other)

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

Parameters
otherthe other UaEndpointUrlListDataType used to initialize the object
UaEndpointUrlListDataType::UaEndpointUrlListDataType ( const OpcUa_EndpointUrlListDataType other)

Constructs an instance of the class UaEndpointUrlListDataType with values from another OpcUa_EndpointUrlListDataType structure.

Parameters
otherthe other OpcUa_EndpointUrlListDataType used to initialize the object
UaEndpointUrlListDataType::UaEndpointUrlListDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the EndpointUrlListDataType
UaEndpointUrlListDataType::UaEndpointUrlListDataType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the EndpointUrlListDataType

Member Function Documentation

void UaEndpointUrlListDataType::attach ( OpcUa_EndpointUrlListDataType pValue)

Attaches to an existing OpcUa_EndpointUrlListDataType structure.

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

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

Clear the data of the UaEndpointUrlListDataType.

OpcUa_EndpointUrlListDataType * UaEndpointUrlListDataType::clone ( const OpcUa_EndpointUrlListDataType source)
static

Copy OpcUa_EndpointUrlListDataType data to a newly allocated OpcUa_EndpointUrlListDataType.

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

Copy OpcUa_EndpointUrlListDataType data to an existing OpcUa_EndpointUrlListDataType structure.

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

Copy UaEndpointUrlListDataType data to a newly allocated OpcUa_EndpointUrlListDataType.

Returns
pointer to a newly allocated OpcUa_EndpointUrlListDataType.
void UaEndpointUrlListDataType::copyTo ( OpcUa_EndpointUrlListDataType pDst) const

Copy UaEndpointUrlListDataType data to an existing OpcUa_EndpointUrlListDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_EndpointUrlListDataType * UaEndpointUrlListDataType::detach ( OpcUa_EndpointUrlListDataType pDst)

Detaches the internal EndpointUrlListDataType structure from this class.

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

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

Compare two UaEndpointUrlListDataType for inequality.

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

Assignment operator.

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

Compare two UaEndpointUrlListDataType for equality.

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

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