UA Server SDK C++ Bundle  1.4.1.271
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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 if they are similar. More...
 
bool operator!= (const UaEndpointUrlListDataType &other) const
 Returns true if the other UaEndpointUrlListDataType is not equal to this. More...
 
UaEndpointUrlListDataTypeoperator= (const UaEndpointUrlListDataType &other)
 Assignment operator. More...
 
OpcUa_EndpointUrlListDataType * copy () 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 the data of the parameter pValue. More...
 
OpcUa_EndpointUrlListDataType * detach (OpcUa_EndpointUrlListDataType *pDst)
 Detaches the internal EndpointUrlListDataType structure from this class. More...
 

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.

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 the data of the parameter pValue.

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

Parameters
[in]pValueParameter 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
new copy.
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
data 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 releasing the EndpointUrlListDataType 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_EndpointUrlListDataType structure that receives the EndpointUrlListDataType data.
bool UaEndpointUrlListDataType::operator!= ( const UaEndpointUrlListDataType other) const

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

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

Assignment operator.

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

Compare two UaEndpointUrlListDataType if they are similar.

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

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