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

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

#include <uaapplicationdescription.h>

Public Member Functions

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

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

See also
UaApplicationDescription for information about the encapsulated structure.

Constructor & Destructor Documentation

UaApplicationDescriptions::UaApplicationDescriptions ( const UaApplicationDescriptions other)

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

Parameters
otherthe other UaApplicationDescriptions used to initialize the object
UaApplicationDescriptions::UaApplicationDescriptions ( OpcUa_Int32  length,
OpcUa_ApplicationDescription data 
)

Constructs an instance of the class UaApplicationDescriptions using a raw OpcUa_ApplicationDescription array.

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

Member Function Documentation

void UaApplicationDescriptions::attach ( OpcUa_UInt32  length,
OpcUa_ApplicationDescription data 
)

Attach to a raw OpcUa_ApplicationDescription array.

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

Attach to a raw OpcUa_ApplicationDescription array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_ApplicationDescription * UaApplicationDescriptions::detach ( )

Detach from the internal OpcUa_ApplicationDescription 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_ApplicationDescription array
bool UaApplicationDescriptions::operator!= ( const UaApplicationDescriptions other) const

Compare two UaApplicationDescriptions.

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

Assignment operator.

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

Compare two UaApplicationDescriptions.

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

Index operator.

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

Index operator.

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