DriveEngine::DefaultPosition3D Class Reference

Inheritance diagram for DriveEngine::DefaultPosition3D:

Public Member Functions
	CONSTRUCTOR_H (IPosition3D, DefaultPosition3D)
	Default constructor. More...
	CONSTRUCTOR_H (IPosition3D, DefaultPosition3D, double x, double y, double z)
	Constructor. More...
	DESTRUCTOR_H (DefaultPosition3D)
virtual double	GetX () const
	Gets the X-axis coordinate. More...
virtual double	GetY () const
	Gets the Y-axis coordinate. More...
virtual double	GetZ () const
	Gets the Z-axis coordinate. More...
virtual void	Set (double x, double y, double z)
	Sets the position. More...
virtual void	SetX (double x)
	Sets the X-axis coordinate. More...
virtual void	SetY (double y)
	Sets the Y-axis coordinate. More...
virtual void	SetZ (double z)
	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...

Member Function Documentation

DriveEngine::DefaultPosition3D::CONSTRUCTOR_H	(	IPosition3D	,
		DefaultPosition3D
	)

Default constructor.

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

DriveEngine::DefaultPosition3D::CONSTRUCTOR_H	(	IPosition3D	,
		DefaultPosition3D	,
		double	x,
		double	y,
		double	z
	)

Constructor.

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.

double DefaultPosition3D::GetX ( ) const

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.

Implements DriveEngine::IPosition3D.

double DefaultPosition3D::GetY ( ) const

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.

Implements DriveEngine::IPosition3D.

double DefaultPosition3D::GetZ ( ) const

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.

Implements DriveEngine::IPosition3D.

void DefaultPosition3D::Set ( double  x, double  y, double  z  )

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.

Implements DriveEngine::IPosition3D.

void DefaultPosition3D::SetX ( double  x )

virtual

Sets the X-axis coordinate.

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

Parameters

x	The X-axis coordinate.

Implements DriveEngine::IPosition3D.

void DefaultPosition3D::SetY ( double  y )

virtual

Sets the Y-axis coordinate.

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

Parameters

y	The Y-axis coordinate.

Implements DriveEngine::IPosition3D.

void DefaultPosition3D::SetZ ( double  z )

virtual

Sets the Z-axis coordinate.

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

Parameters

x	The Z-axis coordinate.

Implements DriveEngine::IPosition3D.

---

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

• Framework/Private/Datatypes/DefaultImplementations/DefaultPosition3D.h
• Framework/Private/Datatypes/DefaultImplementations/DefaultPosition3D.cpp