jas.space
Class GridPosition

java.lang.Object
  jas.space.GridPosition

All Implemented Interfaces:

IGridPosition

public class GridPosition
extends java.lang.Object
implements IGridPosition

An object representing a position on a grid. It has a couple of coordinates just like a Point object, but it is used specifically for Grid implementations.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa

Constructor Summary

GridPosition()
Create a new position at (0, 0).

GridPosition(int xPosition, int yPosition)
Create a new position at the given coordinates.

Method Summary

int	getX() Return the x coordinate.
int	getY() Return the y coordinate.
void	setX(int x) Set the x coordinate.
void	setY(int y) Set the y coordinate.
java.lang.String	toString() A string in the (x, y) format representing a position.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GridPosition

public GridPosition()

Create a new position at (0, 0).

GridPosition

public GridPosition(int xPosition,
                    int yPosition)

Create a new position at the given coordinates.

Parameters:

xPosition - The x coordinate.

yPosition - The y coordinate.

Method Detail

getX

public int getX()

Return the x coordinate.

Specified by:

getX in interface IGridPosition

Returns:

The x position on the grid.

getY

public int getY()

Return the y coordinate.

Specified by:

getY in interface IGridPosition

Returns:

The y position on the grid.

setX

public void setX(int x)

Set the x coordinate.

Specified by:

setX in interface IGridPosition

Parameters:

x - The x position on the grid.

setY

public void setY(int y)

Set the y coordinate.

Specified by:

setY in interface IGridPosition

Parameters:

y - The y position on the grid.

toString

public java.lang.String toString()

A string in the (x, y) format representing a position.

Overrides:

toString in class java.lang.Object