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

#include <uathreedcartesiancoordinates.h>

Public Member Functions
	UaThreeDCartesianCoordinates ()
	Constructs an instance of the class UaThreeDCartesianCoordinates with empty default values.

	UaThreeDCartesianCoordinates (const UaThreeDCartesianCoordinates &other)
	Constructs an instance of the class UaThreeDCartesianCoordinates with values from another UaThreeDCartesianCoordinates object. More...

	UaThreeDCartesianCoordinates (const OpcUa_ThreeDCartesianCoordinates &other)
	Constructs an instance of the class UaThreeDCartesianCoordinates with values from another OpcUa_ThreeDCartesianCoordinates structure. More...

	UaThreeDCartesianCoordinates (OpcUa_Double x, OpcUa_Double y, OpcUa_Double z)
	Constructs an instance of the class UaThreeDCartesianCoordinates with values provided in the constructor.

	UaThreeDCartesianCoordinates (const UaExtensionObject &extensionObject)
	Constructs an instance of the class UaThreeDCartesianCoordinates initialized with value from a UaExtensionObject. More...

	UaThreeDCartesianCoordinates (const OpcUa_ExtensionObject &extensionObject)
	Constructs an instance of the class UaThreeDCartesianCoordinates initialized with value from an OpcUa_ExtensionObject structure. More...

	~UaThreeDCartesianCoordinates ()
	Destroys the UaThreeDCartesianCoordinates object.

void	clear ()
	Clear the data of the UaThreeDCartesianCoordinates. More...

bool	operator== (const UaThreeDCartesianCoordinates &other) const
	Compare two UaThreeDCartesianCoordinates for equality. More...

bool	operator!= (const UaThreeDCartesianCoordinates &other) const
	Compare two UaThreeDCartesianCoordinates for inequality. More...

UaThreeDCartesianCoordinates &	operator= (const UaThreeDCartesianCoordinates &other)
	Assignment operator. More...

OpcUa_ThreeDCartesianCoordinates *	copy () const
	Copy UaThreeDCartesianCoordinates data to a newly allocated OpcUa_ThreeDCartesianCoordinates. More...

void	copyTo (OpcUa_ThreeDCartesianCoordinates *pDst) const
	Copy UaThreeDCartesianCoordinates data to an existing OpcUa_ThreeDCartesianCoordinates structure. More...

void	attach (OpcUa_ThreeDCartesianCoordinates *pValue)
	Attaches to an existing OpcUa_ThreeDCartesianCoordinates structure. More...

OpcUa_ThreeDCartesianCoordinates *	detach (OpcUa_ThreeDCartesianCoordinates *pDst)
	Detaches the internal ThreeDCartesianCoordinates structure from this class. More...

OpcUa_Double	getX () const
	Returns the X.

OpcUa_Double	getY () const
	Returns the Y.

OpcUa_Double	getZ () const
	Returns the Z.

void	setX (OpcUa_Double x)
	Sets the X.

void	setY (OpcUa_Double y)
	Sets the Y.

void	setZ (OpcUa_Double z)
	Sets the Z.

Static Public Member Functions
static OpcUa_ThreeDCartesianCoordinates *	clone (const OpcUa_ThreeDCartesianCoordinates &source)
	Copy OpcUa_ThreeDCartesianCoordinates data to a newly allocated OpcUa_ThreeDCartesianCoordinates. More...

static void	cloneTo (const OpcUa_ThreeDCartesianCoordinates &source, OpcUa_ThreeDCartesianCoordinates &copy)
	Copy OpcUa_ThreeDCartesianCoordinates data to an existing OpcUa_ThreeDCartesianCoordinates structure. More...

Detailed Description

Wrapper class for the UA stack structure OpcUa_ThreeDCartesianCoordinates.

This class encapsulates the native OpcUa_ThreeDCartesianCoordinates structure and handles memory allocation and cleanup for you. UaThreeDCartesianCoordinates uses implicit sharing to avoid needless copying and to boost the performance. Only if you modify a shared ThreeDCartesianCoordinates it creates a copy for that (copy-on-write). So assigning another UaThreeDCartesianCoordinates or passing it as parameter needs constant time and is nearly as fast as assigning a pointer.

Constructor & Destructor Documentation

UaThreeDCartesianCoordinates::UaThreeDCartesianCoordinates ( const UaThreeDCartesianCoordinates & other )

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

Parameters

other the other UaThreeDCartesianCoordinates used to initialize the object

UaThreeDCartesianCoordinates::UaThreeDCartesianCoordinates ( const OpcUa_ThreeDCartesianCoordinates & other )

Constructs an instance of the class UaThreeDCartesianCoordinates with values from another OpcUa_ThreeDCartesianCoordinates structure.

Parameters

other the other OpcUa_ThreeDCartesianCoordinates used to initialize the object

UaThreeDCartesianCoordinates::UaThreeDCartesianCoordinates ( const UaExtensionObject & extensionObject )

Constructs an instance of the class UaThreeDCartesianCoordinates initialized with value from a UaExtensionObject.

Parameters

extensionObject the extension object containing the ThreeDCartesianCoordinates

UaThreeDCartesianCoordinates::UaThreeDCartesianCoordinates ( const OpcUa_ExtensionObject & extensionObject )

Constructs an instance of the class UaThreeDCartesianCoordinates initialized with value from an OpcUa_ExtensionObject structure.

Parameters

extensionObject the extension object containing the ThreeDCartesianCoordinates

Member Function Documentation

void UaThreeDCartesianCoordinates::attach ( OpcUa_ThreeDCartesianCoordinates * pValue )

Attaches to an existing OpcUa_ThreeDCartesianCoordinates structure.

Don't manually free the attached structure afterwards, because UaThreeDCartesianCoordinates is responsible for it now.

Parameters

pValue [in] Parameter to attach to.

void UaThreeDCartesianCoordinates::clear ( )

Clear the data of the UaThreeDCartesianCoordinates.

OpcUa_ThreeDCartesianCoordinates * UaThreeDCartesianCoordinates::clone ( const OpcUa_ThreeDCartesianCoordinates & source )

static

Copy OpcUa_ThreeDCartesianCoordinates data to a newly allocated OpcUa_ThreeDCartesianCoordinates.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_ThreeDCartesianCoordinates.

void UaThreeDCartesianCoordinates::cloneTo	(	const OpcUa_ThreeDCartesianCoordinates &	source,
		OpcUa_ThreeDCartesianCoordinates &	copy
	)

static

Copy OpcUa_ThreeDCartesianCoordinates data to an existing OpcUa_ThreeDCartesianCoordinates structure.

Parameters

source	the source of the clone operation.
copy	the destination of the clone operation.

OpcUa_ThreeDCartesianCoordinates * UaThreeDCartesianCoordinates::copy ( ) const

Copy UaThreeDCartesianCoordinates data to a newly allocated OpcUa_ThreeDCartesianCoordinates.

Returns: pointer to a newly allocated OpcUa_ThreeDCartesianCoordinates.

void UaThreeDCartesianCoordinates::copyTo ( OpcUa_ThreeDCartesianCoordinates * pDst ) const

Copy UaThreeDCartesianCoordinates data to an existing OpcUa_ThreeDCartesianCoordinates structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_ThreeDCartesianCoordinates * UaThreeDCartesianCoordinates::detach ( OpcUa_ThreeDCartesianCoordinates * pDst )

Detaches the internal ThreeDCartesianCoordinates structure from this class.

This way you take over the control of freeing the ThreeDCartesianCoordinates data. If more than one reference exists, the data is copied to pDst instead of being detached.

Parameters

pDst	[out] Pointer to an OpcUa_ThreeDCartesianCoordinates structure that receives the ThreeDCartesianCoordinates data.

Returns: If the function succeeds, pDst is returned, otherwise 0 is returned.

bool UaThreeDCartesianCoordinates::operator!= ( const UaThreeDCartesianCoordinates & other ) const

Compare two UaThreeDCartesianCoordinates for inequality.

See also: operator==

Parameters

other the UaThreeDCartesianCoordinates to compare with.

Returns: true if not equal, false otherwise.

UaThreeDCartesianCoordinates & UaThreeDCartesianCoordinates::operator= ( const UaThreeDCartesianCoordinates & other )

Assignment operator.

Parameters

other the UaThreeDCartesianCoordinates to assign.

Returns: reference to itself.

bool UaThreeDCartesianCoordinates::operator== ( const UaThreeDCartesianCoordinates & other ) const

Compare two UaThreeDCartesianCoordinates for equality.

Parameters

other the UaThreeDCartesianCoordinates to compare with.

Returns: true if equal, false if not.

The documentation for this class was generated from the following files:

C:/work/uasdkcpp/src/uabase/uabasecpp/uathreedcartesiancoordinates.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uathreedcartesiancoordinates.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation