worldsimulator
Class SimulatorImage

java.lang.Object
  |
  +--worldsimulator.SimulatorImage

All Implemented Interfaces:

Serializable, UAVImage

public class SimulatorImage

extends Object

implements Serializable, UAVImage

See Also:

Serialized Form

Field Summary

private Long	ID The ID of the UAV that took this image.
private Map	image The image as a 2D int array.
private objects.Location	loc The location at which this image was taken.
private double	radius The radius after which the image is not significant.
private objects.Location	sourceLoc The Location of the object in the image that took this image.

Constructor Summary

SimulatorImage(Map image, objects.Location loc, double radius, Long ID, objects.Location sourceLoc)

Method Summary

void	clear() The clear method is necessary to null out the int[][] representing the image.
long	getImageSourceID() Returns the ID of the UAV that took this image.
objects.Location	getLocation() Returns the location at which this picture was taken.
Map	getObjectMap() Returns a mapping of Location to Integer objects that denote their type.
double	getRadius() Returns the radius of the unit square in which this image's data is significant.
Object	getSourceObjectLocation() Returns the Location of the object in the image that took this image.
private void	readObject(ObjectInputStream in)
String	toString()
private void	writeObject(ObjectOutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

image

private transient Map image

The image as a 2D int array.

loc

private final objects.Location loc

The location at which this image was taken.

radius

private final double radius

The radius after which the image is not significant.

ID

private final Long ID

The ID of the UAV that took this image.

sourceLoc

private final objects.Location sourceLoc

The Location of the object in the image that took this image.

Constructor Detail

SimulatorImage

public SimulatorImage(Map image,
                      objects.Location loc,
                      double radius,
                      Long ID,
                      objects.Location sourceLoc)

Method Detail

clear

public void clear()

The clear method is necessary to null out the int[][] representing the image. This enables the garbage collector to keep up with the program.

getObjectMap

public Map getObjectMap()

Description copied from interface: UAVImage

Returns a mapping of Location to Integer objects that denote their type.

Specified by:

getObjectMap in interface UAVImage

See Also:

ObjectLocater, ComponentizedSimulator

getLocation

public objects.Location getLocation()

Description copied from interface: UAVImage

Returns the location at which this picture was taken.

Specified by:

getLocation in interface UAVImage

getRadius

public double getRadius()

Description copied from interface: UAVImage

Returns the radius of the unit square in which this image's data is significant.

Specified by:

getRadius in interface UAVImage

getImageSourceID

public long getImageSourceID()

Description copied from interface: UAVImage

Returns the ID of the UAV that took this image.

Specified by:

getImageSourceID in interface UAVImage

getSourceObjectLocation

public Object getSourceObjectLocation()

Description copied from interface: UAVImage

Returns the Location of the object in the image that took this image.

Specified by:

getSourceObjectLocation in interface UAVImage

toString

public String toString()

Overrides:

toString in class Object

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

IOException