Boeing Simulation 3.1 API Specification

objects
Interface Locatable

All Known Subinterfaces:
Destroyable, Movable, Targetable, UAV, UCAV
All Known Implementing Classes:
Bus, Location, MovableWhatWhere, MovingObject, School, SimulatorBus, SimulatorSchool, SimulatorTank, SimulatorUAV, SimulatorUCAV, Tank, UAVObject, UCAVObject, WhatWhere

public interface Locatable

The interface for describing that has a definitive location in the physical world and can be described in relational terms to other Locatable objects.

Version:
$Revision: 1.4 $
Author:
Dave Jurgens

Method Summary
 double getDistance(objects.Locatable loc)
          Returns the distance on the unit square between this and loc.
 objects.Location getLoc()
          Returns the Location of this Locatable.
 boolean isEastOf(objects.Locatable loc)
          Returns whether this Locatable is south of loc.
 boolean isNorthOf(objects.Locatable loc)
          Returns whether this Locatable is north of loc.
 boolean isSouthOf(objects.Locatable loc)
          Returns whether this Locatable is east of loc.
 boolean isWestOf(objects.Locatable loc)
          Returns whether this Locatable is west of loc.
 

Method Detail

getLoc

public objects.Location getLoc()
Returns the Location of this Locatable.


getDistance

public double getDistance(objects.Locatable loc)
Returns the distance on the unit square between this and loc.


isNorthOf

public boolean isNorthOf(objects.Locatable loc)
Returns whether this Locatable is north of loc.


isEastOf

public boolean isEastOf(objects.Locatable loc)
Returns whether this Locatable is south of loc.


isSouthOf

public boolean isSouthOf(objects.Locatable loc)
Returns whether this Locatable is east of loc.


isWestOf

public boolean isWestOf(objects.Locatable loc)
Returns whether this Locatable is west of loc.


Boeing Simulation 3.1 API Specification

To submit a bug or feature email the author of that class. Funding for this research was provided by Boeing and DARPA.