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

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

#include <uathreedvector.h>

Public Member Functions

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

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

See also
UaThreeDVector for information about the encapsulated structure.

Constructor & Destructor Documentation

UaThreeDVectors::UaThreeDVectors ( const UaThreeDVectors other)

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

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

Constructs an instance of the class UaThreeDVectors using a raw OpcUa_ThreeDVector array.

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

Member Function Documentation

void UaThreeDVectors::attach ( OpcUa_UInt32  length,
OpcUa_ThreeDVector *  data 
)

Attach to a raw OpcUa_ThreeDVector array.

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

Attach to a raw OpcUa_ThreeDVector array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_ThreeDVector * UaThreeDVectors::detach ( )

Detach from the internal OpcUa_ThreeDVector 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_ThreeDVector array
bool UaThreeDVectors::operator!= ( const UaThreeDVectors other) const

Compare two UaThreeDVectors.

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

Assignment operator.

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

Compare two UaThreeDVectors.

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

Index operator.

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

Index operator.

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