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

#include <uathreedorientation.h>

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

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

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

	UaThreeDOrientation (OpcUa_Double a, OpcUa_Double b, OpcUa_Double c)
	Constructs an instance of the class UaThreeDOrientation with values provided in the constructor.

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

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

	~UaThreeDOrientation ()
	Destroys the UaThreeDOrientation object.

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

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

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

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

OpcUa_ThreeDOrientation *	copy () const
	Copy UaThreeDOrientation data to a newly allocated OpcUa_ThreeDOrientation. More...

void	copyTo (OpcUa_ThreeDOrientation *pDst) const
	Copy UaThreeDOrientation data to an existing OpcUa_ThreeDOrientation structure. More...

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

OpcUa_ThreeDOrientation *	detach (OpcUa_ThreeDOrientation *pDst)
	Detaches the internal ThreeDOrientation structure from this class. More...

OpcUa_Double	getA () const
	Returns the A.

OpcUa_Double	getB () const
	Returns the B.

OpcUa_Double	getC () const
	Returns the C.

void	setA (OpcUa_Double a)
	Sets the A.

void	setB (OpcUa_Double b)
	Sets the B.

void	setC (OpcUa_Double c)
	Sets the C.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_ThreeDOrientation.

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

Constructor & Destructor Documentation

UaThreeDOrientation::UaThreeDOrientation ( const UaThreeDOrientation & other )

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

Parameters

other the other UaThreeDOrientation used to initialize the object

UaThreeDOrientation::UaThreeDOrientation ( const OpcUa_ThreeDOrientation & other )

Constructs an instance of the class UaThreeDOrientation with values from another OpcUa_ThreeDOrientation structure.

Parameters

other the other OpcUa_ThreeDOrientation used to initialize the object

UaThreeDOrientation::UaThreeDOrientation ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the ThreeDOrientation

UaThreeDOrientation::UaThreeDOrientation ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the ThreeDOrientation

Member Function Documentation

void UaThreeDOrientation::attach ( OpcUa_ThreeDOrientation * pValue )

Attaches to an existing OpcUa_ThreeDOrientation structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaThreeDOrientation::clear ( )

Clear the data of the UaThreeDOrientation.

OpcUa_ThreeDOrientation * UaThreeDOrientation::clone ( const OpcUa_ThreeDOrientation & source )

static

Copy OpcUa_ThreeDOrientation data to a newly allocated OpcUa_ThreeDOrientation.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_ThreeDOrientation.

void UaThreeDOrientation::cloneTo	(	const OpcUa_ThreeDOrientation &	source,
		OpcUa_ThreeDOrientation &	copy
	)

static

Copy OpcUa_ThreeDOrientation data to an existing OpcUa_ThreeDOrientation structure.

Parameters

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

OpcUa_ThreeDOrientation * UaThreeDOrientation::copy ( ) const

Copy UaThreeDOrientation data to a newly allocated OpcUa_ThreeDOrientation.

Returns: pointer to a newly allocated OpcUa_ThreeDOrientation.

void UaThreeDOrientation::copyTo ( OpcUa_ThreeDOrientation * pDst ) const

Copy UaThreeDOrientation data to an existing OpcUa_ThreeDOrientation structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_ThreeDOrientation * UaThreeDOrientation::detach ( OpcUa_ThreeDOrientation * pDst )

Detaches the internal ThreeDOrientation structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_ThreeDOrientation structure that receives the ThreeDOrientation data.

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

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

Compare two UaThreeDOrientation for inequality.

See also: operator==

Parameters

other the UaThreeDOrientation to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaThreeDOrientation to assign.

Returns: reference to itself.

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

Compare two UaThreeDOrientation for equality.

Parameters

other the UaThreeDOrientation 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/uathreedorientation.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uathreedorientation.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation