BubbleField::Coordinates Class Reference

Class that encapsulates coordinates used in BubbleField. More...

List of all members.

Public Member Functions
	Coordinates (unsigned _plate, unsigned _x, unsigned _y)
	Constructor.
bool	operator< (const Coordinates &rhs) const
	Implements function less than.
bool	operator== (const Coordinates &rhs) const
	Comparison operator.
bool	operator!= (const Coordinates &rhs) const
	Comparison operator.
Public Attributes
unsigned	plate
	Plate index.
unsigned	x
	X coordinate.
unsigned	y
	Y coordinate.

---

Detailed Description

Class that encapsulates coordinates used in BubbleField.

---

Constructor & Destructor Documentation

BubbleField::Coordinates::Coordinates	(	unsigned	_plate,
		unsigned	_x,
		unsigned	_y
	)			[inline]

Constructor.

---

Member Function Documentation

bool BubbleField::Coordinates::operator<

(

const Coordinates &

rhs

)

const [inline]

Implements function less than.

Parameters:

[in]

rhs

Right handed side

Returns:

Look to the implementation what it returns

Implemented in order to be able to include Coordinates to std::set. It is asymetric, transitive and ireflexive.

References plate, x, and y.

bool BubbleField::Coordinates::operator==

(

const Coordinates &

rhs

)

const [inline]

Comparison operator.

Parameters:

[in]

rhs

Right hand side

References plate, x, and y.

bool BubbleField::Coordinates::operator!=

(

const Coordinates &

rhs

)

const [inline]

Comparison operator.

Parameters:

[in]

rhs

Right hand side

---

Member Data Documentation

unsigned BubbleField::Coordinates::plate

Plate index.

Referenced by BubbleField::isInvalidPosition::operator()(), operator<(), and operator==().

unsigned BubbleField::Coordinates::x

X coordinate.

Referenced by BubbleField::isInvalidPosition::operator()(), operator<(), and operator==().

unsigned BubbleField::Coordinates::y

Y coordinate.

Referenced by BubbleField::isInvalidPosition::operator()(), operator<(), and operator==().

---

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

• /home/s3rvac/Projects/FIT/PGR/Projekt/trunk/src/bubble_field.h