C++ Based OPC UA Client/Server SDK  1.5.5.355

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

#include <uadeletereferencesitem.h>

Public Member Functions

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

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

See also
UaDeleteReferencesItem for information about the encapsulated structure.

Constructor & Destructor Documentation

UaDeleteReferencesItems::UaDeleteReferencesItems ( const UaDeleteReferencesItems other)

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

Parameters
otherthe other UaDeleteReferencesItems used to initialize the object
UaDeleteReferencesItems::UaDeleteReferencesItems ( OpcUa_Int32  length,
OpcUa_DeleteReferencesItem data 
)

Constructs an instance of the class UaDeleteReferencesItems using a raw OpcUa_DeleteReferencesItem array.

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

Member Function Documentation

void UaDeleteReferencesItems::attach ( OpcUa_UInt32  length,
OpcUa_DeleteReferencesItem data 
)

Attach to a raw OpcUa_DeleteReferencesItem array.

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

Attach to a raw OpcUa_DeleteReferencesItem array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_DeleteReferencesItem * UaDeleteReferencesItems::detach ( )

Detach from the internal OpcUa_DeleteReferencesItem 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_DeleteReferencesItem array
bool UaDeleteReferencesItems::operator!= ( const UaDeleteReferencesItems other) const

Compare two UaDeleteReferencesItems.

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

Assignment operator.

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

Compare two UaDeleteReferencesItems.

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

Index operator.

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

Index operator.

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