C++ Based OPC UA Client/Server SDK  1.5.5.355
UaProgramDiagnosticDataTypes Class Reference

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

#include <uaprogramdiagnosticdatatype.h>

Public Member Functions

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

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

See also
UaProgramDiagnosticDataType for information about the encapsulated structure.

Constructor & Destructor Documentation

UaProgramDiagnosticDataTypes::UaProgramDiagnosticDataTypes ( const UaProgramDiagnosticDataTypes other)

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

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

Constructs an instance of the class UaProgramDiagnosticDataTypes using a raw OpcUa_ProgramDiagnosticDataType array.

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

Member Function Documentation

void UaProgramDiagnosticDataTypes::attach ( OpcUa_UInt32  length,
OpcUa_ProgramDiagnosticDataType *  data 
)

Attach to a raw OpcUa_ProgramDiagnosticDataType array.

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

Attach to a raw OpcUa_ProgramDiagnosticDataType array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_ProgramDiagnosticDataType * UaProgramDiagnosticDataTypes::detach ( )

Detach from the internal OpcUa_ProgramDiagnosticDataType 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_ProgramDiagnosticDataType array
bool UaProgramDiagnosticDataTypes::operator!= ( const UaProgramDiagnosticDataTypes other) const

Compare two UaProgramDiagnosticDataTypes.

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

Assignment operator.

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

Compare two UaProgramDiagnosticDataTypes.

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

Index operator.

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

Index operator.

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