C++ Based OPC UA Client/Server SDK  1.5.3.346
UaMonitoredItemCreateResults Class Reference

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

#include <uaarraytemplates.h>

Public Member Functions

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

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

Constructor & Destructor Documentation

UaMonitoredItemCreateResults::UaMonitoredItemCreateResults ( const UaMonitoredItemCreateResults other)

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

Parameters
otherthe other MonitoredItemCreateResults used to initialize the object
UaMonitoredItemCreateResults::UaMonitoredItemCreateResults ( OpcUa_Int32  length,
OpcUa_MonitoredItemCreateResult data 
)

Constructs an instance of the class UaMonitoredItemCreateResult using a raw OpcUa_MonitoredItemCreateResult array.

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

Member Function Documentation

void UaMonitoredItemCreateResults::attach ( OpcUa_UInt32  length,
OpcUa_MonitoredItemCreateResult data 
)

Attach to a raw OpcUa_MonitoredItemCreateResult array.

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

Attach to a raw OpcUa_MonitoredItemCreateResult array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_MonitoredItemCreateResult * UaMonitoredItemCreateResults::detach ( )

Detach from the internal OpcUa_MonitoredItemCreateResult 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_MonitoredItemCreateResult array
bool UaMonitoredItemCreateResults::operator!= ( const UaMonitoredItemCreateResults other) const

Compare two UaMonitoredItemCreateResults.

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

Assignment operator.

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

Compare two UaMonitoredItemCreateResults.

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

Index operator.

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

Index operator.

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