C++ Based OPC UA Client/Server SDK  1.6.3.406

Array class for the UA stack structure OpcUa_EndpointConfiguration. More...

#include <uaendpointconfiguration.h>

Public Member Functions

 UaEndpointConfigurations ()
 Constructs an empty instance of the class UaEndpointConfigurations.
 
 UaEndpointConfigurations (const UaEndpointConfigurations &other)
 Constructs an instance of the class UaEndpointConfigurations with values from another UaEndpointConfigurations object. More...
 
 UaEndpointConfigurations (OpcUa_Int32 length, OpcUa_EndpointConfiguration *data)
 Constructs an instance of the class UaEndpointConfigurations using a raw OpcUa_EndpointConfiguration array. More...
 
virtual ~UaEndpointConfigurations ()
 Destroys the UaEndpointConfigurations object.
 
UaEndpointConfigurationsoperator= (const UaEndpointConfigurations &other)
 Assignment operator. More...
 
const OpcUa_EndpointConfiguration & operator[] (OpcUa_UInt32 index) const
 Index operator. More...
 
OpcUa_EndpointConfiguration & operator[] (OpcUa_UInt32 index)
 Index operator. More...
 
bool operator== (const UaEndpointConfigurations &other) const
 Compare two UaEndpointConfigurations. More...
 
bool operator!= (const UaEndpointConfigurations &other) const
 Compare two UaEndpointConfigurations. More...
 
void attach (OpcUa_UInt32 length, OpcUa_EndpointConfiguration *data)
 Attach to a raw OpcUa_EndpointConfiguration array. More...
 
void attach (OpcUa_Int32 length, OpcUa_EndpointConfiguration *data)
 Attach to a raw OpcUa_EndpointConfiguration array. More...
 
OpcUa_EndpointConfiguration * detach ()
 Detach from the internal OpcUa_EndpointConfiguration array. More...
 
void create (OpcUa_UInt32 length)
 Clears the array and resizes to the given length. More...
 
void resize (OpcUa_UInt32 length)
 Resizes the array to a given length. More...
 
void clear ()
 Clears the array.
 

Detailed Description

Array class for the UA stack structure OpcUa_EndpointConfiguration.

This class encapsulates an array of the native OpcUa_EndpointConfiguration structure and handles memory allocation and cleanup for you.

See also
UaEndpointConfiguration for information about the encapsulated structure.

Constructor & Destructor Documentation

UaEndpointConfigurations::UaEndpointConfigurations ( const UaEndpointConfigurations other)

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

Parameters
otherthe other UaEndpointConfigurations used to initialize the object
UaEndpointConfigurations::UaEndpointConfigurations ( OpcUa_Int32  length,
OpcUa_EndpointConfiguration *  data 
)

Constructs an instance of the class UaEndpointConfigurations using a raw OpcUa_EndpointConfiguration array.

Parameters
lengththe length of the raw OpcUa_EndpointConfiguration array
datathe raw OpcUa_EndpointConfiguration array

Member Function Documentation

void UaEndpointConfigurations::attach ( OpcUa_UInt32  length,
OpcUa_EndpointConfiguration *  data 
)

Attach to a raw OpcUa_EndpointConfiguration array.

Note
Don't manually free the attached data afterwards, because UaEndpointConfigurations is responsible for it now.
Parameters
lengththe length of the raw OpcUa_EndpointConfiguration array
datathe raw OpcUa_EndpointConfiguration array
void UaEndpointConfigurations::attach ( OpcUa_Int32  length,
OpcUa_EndpointConfiguration *  data 
)

Attach to a raw OpcUa_EndpointConfiguration array.

Note
Don't manually free the attached data afterwards, because UaEndpointConfigurations is responsible for it now.
Parameters
lengththe length of the raw OpcUa_EndpointConfiguration array
datathe raw OpcUa_EndpointConfiguration array
void UaEndpointConfigurations::create ( OpcUa_UInt32  length)

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_EndpointConfiguration * UaEndpointConfigurations::detach ( )

Detach from the internal OpcUa_EndpointConfiguration array.

After detaching, the detached array data will not be cleared automatically anymore.

Note
Remember to retrieve the length of the array before detaching.
Returns
the detached OpcUa_EndpointConfiguration array
bool UaEndpointConfigurations::operator!= ( const UaEndpointConfigurations other) const

Compare two UaEndpointConfigurations.

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

Assignment operator.

Parameters
otherthe UaEndpointConfigurations to assign.
bool UaEndpointConfigurations::operator== ( const UaEndpointConfigurations other) const

Compare two UaEndpointConfigurations.

Parameters
otherthe UaEndpointConfigurations to compare with.
Returns
true if equal, false if not.
const OpcUa_EndpointConfiguration & UaEndpointConfigurations::operator[] ( OpcUa_UInt32  index) const

Index operator.

Parameters
indexthe index of the structure to return.
OpcUa_EndpointConfiguration & UaEndpointConfigurations::operator[] ( OpcUa_UInt32  index)

Index operator.

Parameters
indexthe index of the structure to return.
void UaEndpointConfigurations::resize ( OpcUa_UInt32  length)

Resizes the array to a given length.

Parameters
lengththe new length of the array

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