C++ Based OPC UA Client/Server SDK  1.5.5.355

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

#include <uaaddreferencesitem.h>

Public Member Functions

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

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

See also
UaAddReferencesItem for information about the encapsulated structure.

Constructor & Destructor Documentation

UaAddReferencesItems::UaAddReferencesItems ( const UaAddReferencesItems other)

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

Parameters
otherthe other UaAddReferencesItems used to initialize the object
UaAddReferencesItems::UaAddReferencesItems ( OpcUa_Int32  length,
OpcUa_AddReferencesItem data 
)

Constructs an instance of the class UaAddReferencesItems using a raw OpcUa_AddReferencesItem array.

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

Member Function Documentation

void UaAddReferencesItems::attach ( OpcUa_UInt32  length,
OpcUa_AddReferencesItem data 
)

Attach to a raw OpcUa_AddReferencesItem array.

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

Attach to a raw OpcUa_AddReferencesItem array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_AddReferencesItem * UaAddReferencesItems::detach ( )

Detach from the internal OpcUa_AddReferencesItem 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_AddReferencesItem array
bool UaAddReferencesItems::operator!= ( const UaAddReferencesItems other) const

Compare two UaAddReferencesItems.

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

Assignment operator.

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

Compare two UaAddReferencesItems.

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

Index operator.

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

Index operator.

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