Package org.hortonmachine.gears.libs.modules

Class Node

java.lang.Object

org.hortonmachine.gears.libs.modules.Node

Direct Known Subclasses:

FlowNode, GridNode

public abstract class Node
extends Object

A superclass representing a node.

Author:

Andrea Antonello (www.hydrologis.com)

Field Summary

Fields

Modifier and Type	Field	Description
int	col
int	cols
protected double	doubleNovalue
protected float	floatNovalue
protected javax.media.jai.iterator.RandomIter	gridIter
protected int	intNovalue
protected boolean	isValid
int	row
int	rows
protected boolean	touchesBound
protected boolean	touchesNovalue

Constructor Summary

Constructors

Constructor	Description
Node(javax.media.jai.iterator.RandomIter gridIter, int cols, int rows, int col, int row, Double novalue)

Method Summary

Modifier and Type	Method	Description
double	getDoubleValueFromMap(javax.media.jai.iterator.RandomIter map)	Get the double value of another map in the current node position.
float	getFloatValueFromMap(javax.media.jai.iterator.RandomIter map)	Get the float value of another map in the current node position.
int	getIntValueFromMap(javax.media.jai.iterator.RandomIter map)	Get the int value of another map in the current node position.
double	getValueFromMap(javax.media.jai.iterator.RandomIter map)	Get the value from a map.
boolean	isValid()	Checks if the node is valid.
void	setDoubleValueInMap(javax.media.jai.iterator.WritableRandomIter map, double value)
void	setFloatValueInMap(javax.media.jai.iterator.WritableRandomIter map, float value)	Utility method to set the value of a certain map in the current node position.
void	setIntValueInMap(javax.media.jai.iterator.WritableRandomIter map, int value)
void	setValueInMap(javax.media.jai.iterator.WritableRandomIter map, double value)
boolean	touchesBound()
boolean	touchesNovalue()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

row

public final int row

col

public final int col

cols

public final int cols

rows

public final int rows

isValid

protected boolean isValid

touchesBound

protected boolean touchesBound

touchesNovalue

protected boolean touchesNovalue

gridIter

protected final javax.media.jai.iterator.RandomIter gridIter

doubleNovalue

protected double doubleNovalue

floatNovalue

protected float floatNovalue

intNovalue

protected int intNovalue

Constructor Detail

Node

public Node(javax.media.jai.iterator.RandomIter gridIter,
            int cols,
            int rows,
            int col,
            int row,
            Double novalue)

Method Detail

getValueFromMap

public double getValueFromMap(javax.media.jai.iterator.RandomIter map)

Get the value from a map. Default to getting a double value.

Parameters:

map - the map to read from.

Returns:

the float value read.

getFloatValueFromMap

public float getFloatValueFromMap(javax.media.jai.iterator.RandomIter map)

Get the float value of another map in the current node position.

Parameters:

map - the map from which to get the value.

Returns:

the float value or a novalue.

getIntValueFromMap

public int getIntValueFromMap(javax.media.jai.iterator.RandomIter map)

Get the int value of another map in the current node position.

Parameters:

map - the map from which to get the value.

Returns:

the int value or a novalue.

getDoubleValueFromMap

public double getDoubleValueFromMap(javax.media.jai.iterator.RandomIter map)

Get the double value of another map in the current node position.

Parameters:

map - the map from which to get the value.

Returns:

the double value or a novalue.

setValueInMap

public void setValueInMap(javax.media.jai.iterator.WritableRandomIter map,
                          double value)

setFloatValueInMap

public void setFloatValueInMap(javax.media.jai.iterator.WritableRandomIter map,
                               float value)

Utility method to set the value of a certain map in the current node position.

Parameters:

map - the map to set the value in. if null, it is ignored.

value - the value to set.

setIntValueInMap

public void setIntValueInMap(javax.media.jai.iterator.WritableRandomIter map,
                             int value)

setDoubleValueInMap

public void setDoubleValueInMap(javax.media.jai.iterator.WritableRandomIter map,
                                double value)

isValid

public boolean isValid()

Checks if the node is valid.

A node is valid if

• it is placed inside the raster bounds
• its value is not novalue

Returns:

true if the node is valid.

touchesBound

public boolean touchesBound()

Returns:

true if this node touches a boundary.

touchesNovalue

public boolean touchesNovalue()

Returns:

true if this node touches a novalue.