Coordinate Class Reference

This file is an 'enumeration' class with all the directions. More...

#include <Coordinate.h>

List of all members.

Public Member Functions
	Coordinate (long X, long Y, long Z)
	Coordinate (const Coordinate &rhs)
	~Coordinate ()
Coordinate	operator+ (const Coordinate &rhs) const
Coordinate	operator- (const Coordinate &rhs) const
long	getXCoordinate () const
long	getYCoordinate () const
long	getZCoordinate () const
Static Public Attributes
static Coordinate	NORTH
	The 'north' coordinate.
static Coordinate	NUP
	The 'north up' coordinate.
static Coordinate	NDOWN
	The 'north down' coordinate.
static Coordinate	SOUTH
	The 'south' coordinate.
static Coordinate	SUP
	The 'south up' coordinate.
static Coordinate	SDOWN
	The 'south down' coordinate.
static Coordinate	EAST
	The 'east' coordinate.
static Coordinate	EUP
	The 'east up' coordinate.
static Coordinate	EDOWN
	The 'east down' coordinate.
static Coordinate	WEST
	The 'west' coordinate.
static Coordinate	WUP
	The 'west up' coordinate.
static Coordinate	WDOWN
	The 'west down' coordinate.
static Coordinate	NW
	The 'northwest' coordinate.
static Coordinate	NWUP
	The 'northwest up' coordinate.
static Coordinate	NWDOWN
	The 'northwest down' coordinate.
static Coordinate	NE
	The 'northeast' coordinate.
static Coordinate	NEUP
	The 'northeast up' coordinate.
static Coordinate	NEDOWN
	The 'northeast down' coordinate.
static Coordinate	SW
	The 'southwest' coordinate.
static Coordinate	SWUP
	The 'southwest up' coordinate.
static Coordinate	SWDOWN
	The 'southwest down' coordinate.
static Coordinate	SE
	The 'southeast' coordinate.
static Coordinate	SEUP
	The 'southeast up' coordinate.
static Coordinate	SEDOWN
	The 'southeast down' coordinate.
static Coordinate	UP
	The 'up' coordinate.
static Coordinate	DOWN
	The 'down' coordinate.

---

Detailed Description

This file is an 'enumeration' class with all the directions.

Definition at line 33 of file Coordinate.h.

---

Constructor & Destructor Documentation

Coordinate::Coordinate	(	long	X,
		long	Y,
		long	Z
	)

Specialized constructor

Parameters:

	X	initial X coordinate
	Y	initial Y coordinate
	Z	initial Z coordinate

Coordinate::Coordinate

(

const Coordinate &

rhs

)

Copy Constructor

Parameters:

rhs

Copy from

Coordinate::~Coordinate

(

)

Default destructor

---

Member Function Documentation

Coordinate Coordinate::operator+

(

const Coordinate &

rhs

)

const

Overloaded addition operator

Parameters:

rhs

Coordinate to be added

Returns:

this+rhs

Coordinate Coordinate::operator-

(

const Coordinate &

rhs

)

const

Overloaded substraction operator

Parameters:

rhs

Coordinate to be substracted

Returns:

this-rhs

long Coordinate::getXCoordinate

(

)

const

Getter

Returns:

X coordinate

long Coordinate::getYCoordinate

(

)

const

Getter

Returns:

Y Coordinate

long Coordinate::getZCoordinate

(

)

const

Getter

Returns:

Z coordinate

---

Member Data Documentation

Coordinate Coordinate::NORTH [static]

The 'north' coordinate.

Definition at line 36 of file Coordinate.h.

Coordinate Coordinate::NUP [static]

The 'north up' coordinate.

Definition at line 37 of file Coordinate.h.

Coordinate Coordinate::NDOWN [static]

The 'north down' coordinate.

Definition at line 38 of file Coordinate.h.

Coordinate Coordinate::SOUTH [static]

The 'south' coordinate.

Definition at line 40 of file Coordinate.h.

Coordinate Coordinate::SUP [static]

The 'south up' coordinate.

Definition at line 41 of file Coordinate.h.

Coordinate Coordinate::SDOWN [static]

The 'south down' coordinate.

Definition at line 42 of file Coordinate.h.

Coordinate Coordinate::EAST [static]

The 'east' coordinate.

Definition at line 44 of file Coordinate.h.

Coordinate Coordinate::EUP [static]

The 'east up' coordinate.

Definition at line 45 of file Coordinate.h.

Coordinate Coordinate::EDOWN [static]

The 'east down' coordinate.

Definition at line 46 of file Coordinate.h.

Coordinate Coordinate::WEST [static]

The 'west' coordinate.

Definition at line 48 of file Coordinate.h.

Coordinate Coordinate::WUP [static]

The 'west up' coordinate.

Definition at line 49 of file Coordinate.h.

Coordinate Coordinate::WDOWN [static]

The 'west down' coordinate.

Definition at line 50 of file Coordinate.h.

Coordinate Coordinate::NW [static]

The 'northwest' coordinate.

Definition at line 52 of file Coordinate.h.

Coordinate Coordinate::NWUP [static]

The 'northwest up' coordinate.

Definition at line 53 of file Coordinate.h.

Coordinate Coordinate::NWDOWN [static]

The 'northwest down' coordinate.

Definition at line 54 of file Coordinate.h.

Coordinate Coordinate::NE [static]

The 'northeast' coordinate.

Definition at line 56 of file Coordinate.h.

Coordinate Coordinate::NEUP [static]

The 'northeast up' coordinate.

Definition at line 57 of file Coordinate.h.

Coordinate Coordinate::NEDOWN [static]

The 'northeast down' coordinate.

Definition at line 58 of file Coordinate.h.

Coordinate Coordinate::SW [static]

The 'southwest' coordinate.

Definition at line 60 of file Coordinate.h.

Coordinate Coordinate::SWUP [static]

The 'southwest up' coordinate.

Definition at line 61 of file Coordinate.h.

Coordinate Coordinate::SWDOWN [static]

The 'southwest down' coordinate.

Definition at line 62 of file Coordinate.h.

Coordinate Coordinate::SE [static]

The 'southeast' coordinate.

Definition at line 64 of file Coordinate.h.

Coordinate Coordinate::SEUP [static]

The 'southeast up' coordinate.

Definition at line 65 of file Coordinate.h.

Coordinate Coordinate::SEDOWN [static]

The 'southeast down' coordinate.

Definition at line 66 of file Coordinate.h.

Coordinate Coordinate::UP [static]

The 'up' coordinate.

Definition at line 68 of file Coordinate.h.

Coordinate Coordinate::DOWN [static]

The 'down' coordinate.

Definition at line 69 of file Coordinate.h.

---