|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellChunkAbstract
public abstract class Grid2DSquareCellChunkAbstract
Grid2DSquareCellChunkAbstract provides inner classes for ChunkCellID and general geometry methods for extended classes. It also controls what methods extended classes must implement acting like an interface. The basic geometries are ordered in set numbers of rows and columns and are arranged sequentially as their base two-dimensional orthogonal coordinate axes. The sequential arrangement goes along the x-axis row by row from the y-axis, then up the y-axis taking each row in turn. TODO: Add a int TYPE attribute field which can be used to switch between different types of instances.
Nested Class Summary | |
---|---|
class |
Grid2DSquareCellChunkAbstract.ChunkCellID
A simple ChunkCellID class for distinguishing cells in this chunk. |
Field Summary | |
---|---|
protected Grid2DSquareCellAbstract.ChunkID |
chunkID
For storing the ChunkID of this. |
protected Grid2DSquareCellAbstract |
grid2DSquareCell
A reference to the Grid2DSquareCellDoubleAbstract instance. |
protected boolean |
isSwapUpToDate
Indicator for whether the swapped version of this chunk is upToDate. |
Constructor Summary | |
---|---|
Grid2DSquareCellChunkAbstract()
|
Method Summary | |
---|---|
abstract void |
clearData()
For clearing the data associated with this. |
Grid2DSquareCellAbstract.ChunkID |
getChunkID()
Returns a copy of this.chunkID. |
Grid2DSquareCellAbstract |
getGrid2DSquareCell()
Returns this.grid2DSquareCell. |
protected boolean |
getIsSwapUpToDate()
Returns this.isSwapUpToDate |
java.lang.String |
getName()
Returns the name of this. |
boolean |
inChunk(int chunkCellRowIndex,
int chunkCellColIndex)
Returns true if the cell given by chunk cell row index chunkCellRowIndex, chunk cell col index chunkCellColIndex is in this. |
protected void |
initChunkID(Grid2DSquareCellAbstract.ChunkID chunkID)
Initialises chunkID. |
protected abstract void |
initData()
For initialising the data associated with this. |
protected void |
initGrid2DSquareCell(Grid2DSquareCellAbstract grid2DSquareCell)
Initialises grid2DSquareCell. |
abstract IteratorAbstract |
iterator()
Returns an iterator over the cell values. |
protected void |
setIsSwapUpToDate(boolean isSwapUpToDate)
Returns this.isSwapUpToDate |
abstract java.lang.String |
toString()
For returning a descritption of this. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected transient Grid2DSquareCellAbstract grid2DSquareCell
protected transient Grid2DSquareCellAbstract.ChunkID chunkID
protected transient boolean isSwapUpToDate
Constructor Detail |
---|
public Grid2DSquareCellChunkAbstract()
Method Detail |
---|
public Grid2DSquareCellAbstract getGrid2DSquareCell()
protected void initGrid2DSquareCell(Grid2DSquareCellAbstract grid2DSquareCell)
grid2DSquareCell
- protected void initChunkID(Grid2DSquareCellAbstract.ChunkID chunkID)
chunkID
- public Grid2DSquareCellAbstract.ChunkID getChunkID()
protected boolean getIsSwapUpToDate()
protected void setIsSwapUpToDate(boolean isSwapUpToDate)
public abstract java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getName()
public abstract IteratorAbstract iterator()
public boolean inChunk(int chunkCellRowIndex, int chunkCellColIndex)
chunkCellRowIndex
- chunkCellColIndex
- public abstract void clearData()
protected abstract void initData()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |