|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Layer
Interface for map layers.
TODO: Currently, this is rather limited to rectangular layer structures.
Nested Class Summary | |
---|---|
static class |
Layer.GridLayout
|
static class |
Layer.GridTopology
|
Method Summary | |
---|---|
Unit[] |
getAllUnits()
Returns an array of all units in the map layer; the specific order of the units is unspecified. |
double[][] |
getComponentPlane(int component)
Returns a component plane of the component specified by the argument component . |
double[][] |
getComponentPlane(int component,
int z)
Returns a component plane of the component specified by the argument component . |
Layer.GridLayout |
getGridLayout()
|
Layer.GridTopology |
getGridTopology()
|
String |
getIdString()
Returns the identification string of the map layer. |
int |
getLevel()
Returns the level of the map layer in a hierarchical model. |
double |
getMapDistance(int x1,
int y1,
int z1,
int x2,
int y2,
int z2)
Returns the distance between two units on the map grid. |
double |
getMapDistance(Unit u1,
Unit u2)
Returns the distance between two units on the map grid. |
DistanceMetric |
getMetric()
Returns the metric used for distance calculation. |
int |
getNumberOfMappedInputs()
Returns the total number of Inputs mapped on all units in the map layer. |
QualityMeasure |
getQualityMeasure()
Returns the quality information. |
String |
getRevision()
Returns the revision string of this layer. |
Unit |
getUnit(int x,
int y)
Returns the Unit at the position specified by the x and y arguments. |
Unit |
getUnit(int x,
int y,
int z)
Returns the Unit at the position specified by the x and y arguments. |
Unit |
getUnitForDatum(String name)
Returns the unit onto which the datum specified by its name by argument name is mapped. |
int |
getXSize()
Returns the width of the map layer. |
int |
getYSize()
Returns the height of the map layer. |
int |
getZSize()
Returns the depth of the map layer. |
Method Detail |
---|
double[][] getComponentPlane(int component)
component
. Returns
null
, if the argument component
is out of range.
component
- the index of the component.
null
if argument component
is invalid.double[][] getComponentPlane(int component, int z)
component
. Returns
null
, if the argument component
is out of range.
component
- the index of the component.z
- TODO
null
if argument component
is invalid.String getIdString()
int getLevel()
double getMapDistance(int x1, int y1, int z1, int x2, int y2, int z2)
x1
- the horizontal position of the first unit.y1
- the vertical position of the first unit.z1
- the height position of the first unit.x2
- the horizontal position of the second unit.y2
- the vertical position of the second unit.z2
- the height position of the second unit.
double getMapDistance(Unit u1, Unit u2)
u1
- the first unit.u2
- the second unit.
DistanceMetric getMetric()
QualityMeasure getQualityMeasure()
null
if not existent.String getRevision()
Unit getUnit(int x, int y) throws LayerAccessException
Unit
at the position specified by the x
and y
arguments. A
LayerAccessException
is thrown, if the coordinates are invalid.
x
- the horizontal position on the map layer.y
- the vertical position on the map layer.
LayerAccessException
- if the coordinates are out of range.Unit getUnit(int x, int y, int z) throws LayerAccessException
Unit
at the position specified by the x
and y
arguments. A
LayerAccessException
is thrown, if the coordinates are invalid.
x
- the horizontal position on the map layer.y
- the vertical position on the map layer.z
- TODO
LayerAccessException
- if the coordinates are out of range.Unit getUnitForDatum(String name)
name
is mapped.
name
- the name of the input datum to be searched for.
null
if the datum is not found on the map.int getXSize()
int getYSize()
int getZSize()
int getNumberOfMappedInputs()
Unit[] getAllUnits()
Layer.GridTopology getGridTopology()
Layer.GridLayout getGridLayout()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |