DriveEngine::IPosition3D Class Reference

The 3D position datatype interface. More...

#include <IPosition3D.h>

Inheritance diagram for DriveEngine::IPosition3D:

Public Member Functions
virtual double	GetX () const =0
	Gets the X-axis coordinate. More...
virtual double	GetY () const =0
	Gets the Y-axis coordinate. More...
virtual double	GetZ () const =0
	Gets the Z-axis coordinate. More...
virtual void	Set (double x, double y, double z)=0
	Sets the position. More...
virtual void	SetX (double x)=0
	Sets the X-axis coordinate. More...
virtual void	SetY (double y)=0
	Sets the Y-axis coordinate. More...
virtual void	SetZ (double z)=0
	Sets the Z-axis coordinate. More...
Public Member Functions inherited from IExportable
virtual void	Delete () const =0
	Deletes the current object. Needed for memory management. More...

Detailed Description

The 3D position datatype interface.

It minimally contain a position in 3D Cartesian coordinate system.

Member Function Documentation

virtual double DriveEngine::IPosition3D::GetX ( ) const

pure virtual

Gets the X-axis coordinate.

It's value is a real number. It is highly recommended to keep position relatively near the origin for precision.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Returns

The X-axis coordinate.

Implemented in DriveEngine::DefaultPosition3D.

virtual double DriveEngine::IPosition3D::GetY ( ) const

pure virtual

Gets the Y-axis coordinate.

It's value is a real number. It is highly recommended to keep position relatively near the origin for precision.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Returns

The Y-axis coordinate.

Implemented in DriveEngine::DefaultPosition3D.

virtual double DriveEngine::IPosition3D::GetZ ( ) const

pure virtual

Gets the Z-axis coordinate.

It's value is a real number. It is highly recommended to keep position relatively near the origin for precision.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Returns

The Z-axis coordinate.

Implemented in DriveEngine::DefaultPosition3D.

virtual void DriveEngine::IPosition3D::Set ( double  x, double  y, double  z  )

pure virtual

Sets the position.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Parameters

x	The X-axis coordinate.
y	The Y-axis coordinate.
z	The Z-axis coordinate.

Implemented in DriveEngine::DefaultPosition3D.

virtual void DriveEngine::IPosition3D::SetX ( double  x )

pure virtual

Sets the X-axis coordinate.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Parameters

x	The X-axis coordinate.

Implemented in DriveEngine::DefaultPosition3D.

virtual void DriveEngine::IPosition3D::SetY ( double  y )

pure virtual

Sets the Y-axis coordinate.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Parameters

y	The Y-axis coordinate.

Implemented in DriveEngine::DefaultPosition3D.

virtual void DriveEngine::IPosition3D::SetZ ( double  z )

pure virtual

Sets the Z-axis coordinate.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Parameters

x	The Z-axis coordinate.

Implemented in DriveEngine::DefaultPosition3D.

---

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

• Framework/Public/Datatypes/IPosition3D.h