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

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

#include <uaendpointdescription.h>

Public Member Functions

 UaEndpointDescriptions ()
 Constructs an empty instance of the class UaEndpointDescriptions.
 
 UaEndpointDescriptions (const UaEndpointDescriptions &other)
 Constructs an instance of the class UaEndpointDescriptions with values from another UaEndpointDescriptions object. More...
 
 UaEndpointDescriptions (OpcUa_Int32 length, OpcUa_EndpointDescription *data)
 Constructs an instance of the class UaEndpointDescriptions using a raw OpcUa_EndpointDescription array. More...
 
virtual ~UaEndpointDescriptions ()
 Destroys the UaEndpointDescriptions object.
 
UaEndpointDescriptionsoperator= (const UaEndpointDescriptions &other)
 Assignment operator. More...
 
const OpcUa_EndpointDescriptionoperator[] (OpcUa_UInt32 index) const
 Index operator. More...
 
OpcUa_EndpointDescriptionoperator[] (OpcUa_UInt32 index)
 Index operator. More...
 
bool operator== (const UaEndpointDescriptions &other) const
 Compare two UaEndpointDescriptions. More...
 
bool operator!= (const UaEndpointDescriptions &other) const
 Compare two UaEndpointDescriptions. More...
 
void attach (OpcUa_UInt32 length, OpcUa_EndpointDescription *data)
 Attach to a raw OpcUa_EndpointDescription array. More...
 
void attach (OpcUa_Int32 length, OpcUa_EndpointDescription *data)
 Attach to a raw OpcUa_EndpointDescription array. More...
 
OpcUa_EndpointDescriptiondetach ()
 Detach from the internal OpcUa_EndpointDescription 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_EndpointDescription.

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

See also
UaEndpointDescription for information about the encapsulated structure.

Constructor & Destructor Documentation

UaEndpointDescriptions::UaEndpointDescriptions ( const UaEndpointDescriptions other)

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

Parameters
otherthe other UaEndpointDescriptions used to initialize the object
UaEndpointDescriptions::UaEndpointDescriptions ( OpcUa_Int32  length,
OpcUa_EndpointDescription data 
)

Constructs an instance of the class UaEndpointDescriptions using a raw OpcUa_EndpointDescription array.

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

Member Function Documentation

void UaEndpointDescriptions::attach ( OpcUa_UInt32  length,
OpcUa_EndpointDescription data 
)

Attach to a raw OpcUa_EndpointDescription array.

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

Attach to a raw OpcUa_EndpointDescription array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_EndpointDescription * UaEndpointDescriptions::detach ( )

Detach from the internal OpcUa_EndpointDescription 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_EndpointDescription array
bool UaEndpointDescriptions::operator!= ( const UaEndpointDescriptions other) const

Compare two UaEndpointDescriptions.

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

Assignment operator.

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

Compare two UaEndpointDescriptions.

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

Index operator.

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

Index operator.

Parameters
indexthe index of the structure to return.
void UaEndpointDescriptions::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: