jadex.swing.map
Class Locus

java.lang.Object
  |
  +--jadex.swing.map.Locus
All Implemented Interfaces:
MapPoint

public class Locus
extends java.lang.Object
implements MapPoint

An implementataion of MapPoint. This class holds information on a Locus from AceDB. In fact, this is a wrapper for the AceObject for the Locus.


Constructor Summary
Locus()
          Default constructor.
Locus(jade.db.AceObject o)
          An overloaded constructor.
Locus(java.lang.String name, float pos)
          An overloaded construtor.
Locus(java.lang.String name, float pos, jade.db.AceObject o)
          An overloaded constructor.
Locus(java.lang.String name, float pos, float err, jade.db.AceObject o)
          An overloaded constructor.
 
Method Summary
 jade.db.AceObject getAceObject()
          Get the AceObject.
 float getError()
          Get the error of the position of this MapPoint.
 java.lang.String getName()
          Get the name of this Locus.
 float getPosition()
          Get the position of this Locus.
 void setAceObject(jade.db.AceObject o)
          Set up the AceObject for this Locus.
 void setError(float err)
          Set the error of the position of this MapPoint.
 void setName(java.lang.String name)
          Set the name of the mappoint.
 void setPosition(float position)
          Set the position of the MapPoint.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Locus

public Locus()
Default constructor.

Locus

public Locus(java.lang.String name,
             float pos)
An overloaded construtor.
Parameters:
name - the name of the Locus.
pos - the posistion of this Locus.

Locus

public Locus(java.lang.String name,
             float pos,
             jade.db.AceObject o)
An overloaded constructor.
Parameters:
name - the name of the Locus.
pos - the position of this Locus.
o - the AceObejct holding all information for this Locus.

Locus

public Locus(java.lang.String name,
             float pos,
             float err,
             jade.db.AceObject o)
An overloaded constructor.
Parameters:
name - the name of this locus.
pos - the position of this locus.
err - the error of the position of this locus.
o - the AceObejct.

Locus

public Locus(jade.db.AceObject o)
An overloaded constructor.
Parameters:
o - the AceObject holding all information for this locus.
Method Detail

setAceObject

public void setAceObject(jade.db.AceObject o)
Set up the AceObject for this Locus.
Parameters:
o - the AceObject holding all information for this Locus.

getAceObject

public jade.db.AceObject getAceObject()
Get the AceObject.

getPosition

public float getPosition()
                  throws UnknownPositionException
Get the position of this Locus.
Specified by:
getPosition in interface MapPoint
Returns:
the position of this Locus.
Throws:
throw - an exception if the position has not be set.

getName

public java.lang.String getName()
Get the name of this Locus.
Specified by:
getName in interface MapPoint
Returns:
the name of this Locus.

setName

public void setName(java.lang.String name)
Description copied from interface: MapPoint
Set the name of the mappoint.
Specified by:
setName in interface MapPoint

setPosition

public void setPosition(float position)
Description copied from interface: MapPoint
Set the position of the MapPoint.
Specified by:
setPosition in interface MapPoint
Following copied from interface: jadex.swing.map.MapPoint
Parameters:
position - the position of the MapPoint.

setError

public void setError(float err)
Description copied from interface: MapPoint
Set the error of the position of this MapPoint.
Specified by:
setError in interface MapPoint
Following copied from interface: jadex.swing.map.MapPoint
Parameters:
err - the error of the position

getError

public float getError()
Description copied from interface: MapPoint
Get the error of the position of this MapPoint.
Specified by:
getError in interface MapPoint
Following copied from interface: jadex.swing.map.MapPoint
Returns:
the error of the position of the MapPoint.