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

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

#include <uaarraytemplates.h>

Public Member Functions

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

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

Constructor & Destructor Documentation

UaMonitoredItemNotifications::UaMonitoredItemNotifications ( const UaMonitoredItemNotifications other)

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

Parameters
otherthe other MonitoredItemNotifications used to initialize the object
UaMonitoredItemNotifications::UaMonitoredItemNotifications ( OpcUa_Int32  length,
OpcUa_MonitoredItemNotification *  data 
)

Constructs an instance of the class UaMonitoredItemNotification using a raw OpcUa_MonitoredItemNotification array.

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

Member Function Documentation

void UaMonitoredItemNotifications::attach ( OpcUa_UInt32  length,
OpcUa_MonitoredItemNotification *  data 
)

Attach to a raw OpcUa_MonitoredItemNotification array.

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

Attach to a raw OpcUa_MonitoredItemNotification array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_MonitoredItemNotification * UaMonitoredItemNotifications::detach ( )

Detach from the internal OpcUa_MonitoredItemNotification 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_MonitoredItemNotification array
bool UaMonitoredItemNotifications::operator!= ( const UaMonitoredItemNotifications other) const

Compare two UaMonitoredItemNotifications.

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

Assignment operator.

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

Compare two UaMonitoredItemNotifications.

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

Index operator.

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

Index operator.

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