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

#include <uaaxisinformation.h>

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

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

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

	UaAxisInformation (const UaEUInformation &engineeringUnits, const UaRange &eURange, const UaLocalizedText &title, OpcUa_AxisScaleEnumeration axisScaleType, const UaDoubleArray &axisSteps)
	Constructs an instance of the class UaAxisInformation with values provided in the constructor.

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

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

	UaAxisInformation (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)

	UaAxisInformation (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)

	~UaAxisInformation ()
	Destroys the UaAxisInformation object.

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

bool	operator== (const UaAxisInformation &other) const
	Compare two UaAxisInformation if they are similar. More...

bool	operator!= (const UaAxisInformation &other) const
	Returns true if the other UaAxisInformation is not equal to this. More...

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

OpcUa_AxisInformation *	copy () const
	Copy UaAxisInformation data to a newly allocated OpcUa_AxisInformation. More...

void	copyTo (OpcUa_AxisInformation *pDst) const
	Copy UaAxisInformation data to an existing OpcUa_AxisInformation structure. More...

void	attach (const OpcUa_AxisInformation *pValue)
	Attaches the data of the parameter pValue. More...

OpcUa_AxisInformation *	detach (OpcUa_AxisInformation *pDst)
	Detaches the internal AxisInformation structure from this class. More...

void	toVariant (UaVariant &variant) const

void	toVariant (OpcUa_Variant &variant) const

void	toVariant (UaVariant &variant, OpcUa_Boolean bDetach)

void	toVariant (OpcUa_Variant &variant, OpcUa_Boolean bDetach)

void	toDataValue (UaDataValue &dataValue, OpcUa_Boolean updateTimeStamps) const

void	toDataValue (OpcUa_DataValue &dataValue, OpcUa_Boolean updateTimeStamps) const

void	toDataValue (UaDataValue &dataValue, OpcUa_Boolean bDetach, OpcUa_Boolean updateTimeStamps)

void	toDataValue (OpcUa_DataValue &dataValue, OpcUa_Boolean bDetach, OpcUa_Boolean updateTimeStamps)

void	toExtensionObject (UaExtensionObject &extensionObject) const

void	toExtensionObject (OpcUa_ExtensionObject &extensionObject) const

void	toExtensionObject (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)

void	toExtensionObject (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)

OpcUa_StatusCode	setAxisInformation (const UaExtensionObject &extensionObject)

OpcUa_StatusCode	setAxisInformation (const OpcUa_ExtensionObject &extensionObject)

OpcUa_StatusCode	setAxisInformation (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)

OpcUa_StatusCode	setAxisInformation (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)

void	setAxisInformation (const UaEUInformation &engineeringUnits, const UaRange &eURange, const UaLocalizedText &title, OpcUa_AxisScaleEnumeration axisScaleType, const UaDoubleArray &axisSteps)

UaEUInformation	getEngineeringUnits () const

UaRange	getEURange () const

UaLocalizedText	getTitle () const

OpcUa_AxisScaleEnumeration	getAxisScaleType () const

void	getAxisSteps (UaDoubleArray &axisSteps) const

void	setEngineeringUnits (const UaEUInformation &engineeringUnits)

void	setEURange (const UaRange &eURange)

void	setTitle (const UaLocalizedText &title)

void	setAxisScaleType (OpcUa_AxisScaleEnumeration axisScaleType)

void	setAxisSteps (const UaDoubleArray &axisSteps)

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_AxisInformation.

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

Constructor & Destructor Documentation

UaAxisInformation::UaAxisInformation ( const UaAxisInformation & other )

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

Parameters

other the other UaAxisInformation used to initialize the object

UaAxisInformation::UaAxisInformation ( const OpcUa_AxisInformation & other )

Constructs an instance of the class UaAxisInformation with values from another OpcUa_AxisInformation structure.

Parameters

other the other OpcUa_AxisInformation used to initialize the object

UaAxisInformation::UaAxisInformation ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the AxisInformation

UaAxisInformation::UaAxisInformation ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the AxisInformation

Member Function Documentation

void UaAxisInformation::attach ( const OpcUa_AxisInformation * pValue )

Attaches the data of the parameter pValue.

Don't clear the data of pValue afterwards manually, because UaAxisInformation is responsible for it now.

Parameters

[in] pValue Parameter to attach to.

void UaAxisInformation::clear ( )

Clear the data of the UaAxisInformation.

OpcUa_AxisInformation * UaAxisInformation::clone ( const OpcUa_AxisInformation & source )

static

Copy OpcUa_AxisInformation data to a newly allocated OpcUa_AxisInformation.

Parameters

source Source to clone.

Returns: new copy.

void UaAxisInformation::cloneTo	(	const OpcUa_AxisInformation &	source,
		OpcUa_AxisInformation &	copy
	)

static

Copy OpcUa_AxisInformation data to an existing OpcUa_AxisInformation structure.

Parameters

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

OpcUa_AxisInformation * UaAxisInformation::copy ( ) const

Copy UaAxisInformation data to a newly allocated OpcUa_AxisInformation.

Returns: data to a newly allocated OpcUa_AxisInformation.

void UaAxisInformation::copyTo ( OpcUa_AxisInformation * pDst ) const

Copy UaAxisInformation data to an existing OpcUa_AxisInformation structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_AxisInformation * UaAxisInformation::detach ( OpcUa_AxisInformation * pDst )

Detaches the internal AxisInformation structure from this class.

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

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

Parameters

[out] pDst Pointer to OpcUa_AxisInformation structure that receives the AxisInformation data.

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

Returns true if the other UaAxisInformation is not equal to this.

See Also: operator==

Parameters

other the UaAxisInformation to compare.

Returns: true if other is not equal to this.

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

Assignment operator.

Parameters

other the UaAxisInformation to assign.

Returns: Assignment operator.

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

Compare two UaAxisInformation if they are similar.

Parameters

other the UaAxisInformation to compare.

Returns: true if similar, false if not.

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

D:/work/uasdkcpp/src/uabase/uabasecpp/uaaxisinformation.h
D:/work/uasdkcpp/src/uabase/uabasecpp/uaaxisinformation.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation