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

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

#include <uathreedcartesiancoordinates.h>

Public Member Functions

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

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

See also
UaThreeDCartesianCoordinates for information about the encapsulated structure.

Constructor & Destructor Documentation

UaThreeDCartesianCoordinatess::UaThreeDCartesianCoordinatess ( const UaThreeDCartesianCoordinatess other)

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

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

Constructs an instance of the class UaThreeDCartesianCoordinatess using a raw OpcUa_ThreeDCartesianCoordinates array.

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

Member Function Documentation

void UaThreeDCartesianCoordinatess::attach ( OpcUa_UInt32  length,
OpcUa_ThreeDCartesianCoordinates *  data 
)

Attach to a raw OpcUa_ThreeDCartesianCoordinates array.

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

Attach to a raw OpcUa_ThreeDCartesianCoordinates array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_ThreeDCartesianCoordinates * UaThreeDCartesianCoordinatess::detach ( )

Detach from the internal OpcUa_ThreeDCartesianCoordinates 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_ThreeDCartesianCoordinates array
bool UaThreeDCartesianCoordinatess::operator!= ( const UaThreeDCartesianCoordinatess other) const

Compare two UaThreeDCartesianCoordinatess.

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

Assignment operator.

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

Compare two UaThreeDCartesianCoordinatess.

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

Index operator.

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

Index operator.

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