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

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

#include <uaarraytemplates.h>

Public Member Functions

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

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

Constructor & Destructor Documentation

UaReferenceDescriptions::UaReferenceDescriptions ( const UaReferenceDescriptions other)

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

Parameters
otherthe other ReferenceDescriptions used to initialize the object
UaReferenceDescriptions::UaReferenceDescriptions ( OpcUa_Int32  length,
OpcUa_ReferenceDescription data 
)

Constructs an instance of the class UaReferenceDescription using a raw OpcUa_ReferenceDescription array.

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

Member Function Documentation

void UaReferenceDescriptions::attach ( OpcUa_UInt32  length,
OpcUa_ReferenceDescription data 
)

Attach to a raw OpcUa_ReferenceDescription array.

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

Attach to a raw OpcUa_ReferenceDescription array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_ReferenceDescription * UaReferenceDescriptions::detach ( )

Detach from the internal OpcUa_ReferenceDescription 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_ReferenceDescription array
bool UaReferenceDescriptions::operator!= ( const UaReferenceDescriptions other) const

Compare two UaReferenceDescriptions.

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

Assignment operator.

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

Compare two UaReferenceDescriptions.

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

Index operator.

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

Index operator.

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