C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537

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

#include <uathreedframe.h>

Public Member Functions

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

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

See also
UaThreeDFrame for information about the encapsulated structure.

Constructor & Destructor Documentation

UaThreeDFrames::UaThreeDFrames ( const UaThreeDFrames other)

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

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

Constructs an instance of the class UaThreeDFrames using a raw OpcUa_ThreeDFrame array.

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

Member Function Documentation

void UaThreeDFrames::attach ( OpcUa_UInt32  length,
OpcUa_ThreeDFrame *  data 
)

Attach to a raw OpcUa_ThreeDFrame array.

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

Attach to a raw OpcUa_ThreeDFrame array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_ThreeDFrame * UaThreeDFrames::detach ( )

Detach from the internal OpcUa_ThreeDFrame 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_ThreeDFrame array
bool UaThreeDFrames::operator!= ( const UaThreeDFrames other) const

Compare two UaThreeDFrames.

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

Assignment operator.

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

Compare two UaThreeDFrames.

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

Index operator.

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

Index operator.

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