C++ Based OPC UA Client/Server SDK  1.5.5.355

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

#include <uahistoryeventfieldlist.h>

Public Member Functions

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

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

See also
UaHistoryEventFieldList for information about the encapsulated structure.

Constructor & Destructor Documentation

UaHistoryEventFieldLists::UaHistoryEventFieldLists ( const UaHistoryEventFieldLists other)

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

Parameters
otherthe other UaHistoryEventFieldLists used to initialize the object
UaHistoryEventFieldLists::UaHistoryEventFieldLists ( OpcUa_Int32  length,
OpcUa_HistoryEventFieldList *  data 
)

Constructs an instance of the class UaHistoryEventFieldLists using a raw OpcUa_HistoryEventFieldList array.

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

Member Function Documentation

void UaHistoryEventFieldLists::attach ( OpcUa_UInt32  length,
OpcUa_HistoryEventFieldList *  data 
)

Attach to a raw OpcUa_HistoryEventFieldList array.

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

Attach to a raw OpcUa_HistoryEventFieldList array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_HistoryEventFieldList * UaHistoryEventFieldLists::detach ( )

Detach from the internal OpcUa_HistoryEventFieldList 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_HistoryEventFieldList array
bool UaHistoryEventFieldLists::operator!= ( const UaHistoryEventFieldLists other) const

Compare two UaHistoryEventFieldLists.

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

Assignment operator.

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

Compare two UaHistoryEventFieldLists.

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

Index operator.

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

Index operator.

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