The 2D position datatype interface. More...

Inheritance diagram for DriveEngine::IPosition2D:

Public Member Functions
virtual int	GetX () const =0
	Gets the X-axis coordinate. More...

virtual int	GetY () const =0
	Gets the Y-axis coordinate. More...

virtual void	Set (int x, int y)=0
	Sets the position. More...

virtual void	SetX (int x)=0
	Sets the X-axis coordinate. More...

virtual void	SetY (int y)=0
	Sets the Y-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 2D position datatype interface.

It minimally contain a position in Cartesian coordinate system.

A position parameter must be positive and cannot exceed 32 767.

Member Function Documentation

virtual int DriveEngine::IPosition2D::GetX ( ) const

pure virtual

Gets the X-axis coordinate.

It's value must be positive and cannot exceed 32 767.

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

virtual int DriveEngine::IPosition2D::GetY ( ) const

pure virtual

Gets the Y-axis coordinate.

It's value must be positive and cannot exceed 32 767.

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

virtual void DriveEngine::IPosition2D::Set	(	int	x,
		int	y
	)

pure virtual

Sets the position.

Exception safety : Strong exception safety. This member function throws exceptions.

Parameters

x	The X-axis coordinate. It must be positive and must not exceed 32 767.
y	The Y-axis coordinate. It must be positive and must not exceed 32 767.

virtual void DriveEngine::IPosition2D::SetX ( int x )

pure virtual

Sets the X-axis coordinate.

Exception safety : Strong exception safety. This member function throws exceptions.

Parameters

x	The X-axis coordinate. It must be positive and cannot exceed 32 767.

virtual void DriveEngine::IPosition2D::SetY ( int y )

pure virtual

Sets the Y-axis coordinate.

Exception safety : Strong exception safety. This member function throws exceptions.

Parameters

y	The Y-axis coordinate. It must be positive and cannot exceed 32 767.

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