DriveEngine::DefaultPosition2D Class Reference

Inheritance diagram for DriveEngine::DefaultPosition2D:

Public Member Functions
	CONSTRUCTOR_H (IPosition2D, DefaultPosition2D)
	Default constructor. More...
	CONSTRUCTOR_H (IPosition2D, DefaultPosition2D, int x, int y)
	Constructor. More...
	DESTRUCTOR_H (DefaultPosition2D)
virtual int	GetX () const
	Gets the X-axis coordinate. More...
virtual int	GetY () const
	Gets the Y-axis coordinate. More...
virtual void	Set (int x, int y)
	Sets the position. More...
virtual void	SetX (int x)
	Sets the X-axis coordinate. More...
virtual void	SetY (int y)
	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...

Member Function Documentation

DriveEngine::DefaultPosition2D::CONSTRUCTOR_H	(	IPosition2D	,
		DefaultPosition2D
	)

Default constructor.

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

DriveEngine::DefaultPosition2D::CONSTRUCTOR_H	(	IPosition2D	,
		DefaultPosition2D	,
		int	x,
		int	y
	)

Constructor.

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

Parameters

x	The X-axis coordinate. It must be positive and cannot exceed 32 767. Otherwise, a precondition exception is thrown.
y	The Y-axis coordinate. It must be positive and cannot exceed 32 767. Otherwise, a precondition exception is thrown.

int DefaultPosition2D::GetX ( ) const

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.

Returns

The X-axis coordinate.

Implements DriveEngine::IPosition2D.

int DefaultPosition2D::GetY ( ) const

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.

Returns

The Y-axis coordinate.

Implements DriveEngine::IPosition2D.

void DefaultPosition2D::Set ( int  x, int  y  )

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.

Implements DriveEngine::IPosition2D.

void DefaultPosition2D::SetX ( int  x )

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.

Implements DriveEngine::IPosition2D.

void DefaultPosition2D::SetY ( int  y )

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.

Implements DriveEngine::IPosition2D.

---

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

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