execution.world

Class VehicleObject

java.lang.Object

execution.world.WorldObject

execution.world.MovingObject

execution.world.VehicleObject

All Implemented Interfaces:

Comparable<VehicleObject>

Direct Known Subclasses:

AirVehicle, UnderwaterVehicle

public class VehicleObject
extends MovingObject
implements Comparable<VehicleObject>

A class used to represent a vehicle that has been identified. Implemented primarily to enforce stronger typing between a "vehicle" and other types of "moving objects" Can be used in this form to represent ground or surface vehicles, or extended to represent underwater or airborne vehicles. MOVES Institute Naval Postgraduate School, Monterey, CA www.nps.edu

Since:

9 April 2009, 10:46:41 AM

Version:

$Id: VehicleObject.java 8020 2012-07-03 01:37:06Z brutzman $

Author:

Duane Davis

Field Summary

Fields inherited from class execution.world.WorldObject

potentialVector

Constructor Summary

Constructors

Constructor and Description
VehicleObject(double[] position, double direction, double speed, double time, double standoff, int VID) Constructor
VehicleObject(double x, double y, double direction, double speed, double time, double standoff, int VID) Constructor
VehicleObject(double time, double standoff, int VID) Constructor for a zero-velocity vehicle that will be placed at the origin with zero velocity
VehicleObject(Point position, double direction, double speed, double time, double standoff, int VID) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canCompleteGoal(int goalType) Queries whether the vehicle is capable of completing a specified goal type
int	compareTo(VehicleObject v2) Implements the Comparable interface
String	getCharacteristic(int charNum) Returns a String describing a special capability or characteristic of the vehicle
int	getVehicleType()
Integer	getVID()
boolean	hasCharacteristic(String chr) Does the vehicle have a specific characteristic
boolean	isParticipating()
void	setCapabilities(AvclMessage msg) Uses an AVCL Characteristics message to set the vehicle operating limits and capabilities
void	setParticipating(boolean isParticipating) Sets the vehicle as participating (true) or not (false) in the owning vehicle's group
void	setVID(int newID) Sets the vehicle as participating (true) or not (false) in the owning vehicle's group
String	toString() Generates a string representation of the wall object

Methods inherited from class execution.world.MovingObject

copyStateInfo, getDirection, getPostureTime, getPotentialForce, getPotentialForce, getPotentialForce, getPotentialVector, getPotentialVector, getPotentialVector, getSpeed, isLocated, isTooClose, setDirection, setPosit, setPosit, setPosit, setSpeed, setVelocity, updatePositionDR, updatePositionFix, updatePositionFix, updatePositionFix

Methods inherited from class execution.world.WorldObject

getDistance, getDistance, getDistance, getDistance, getDistance, getDistance, getDistance, getDistanceOfConcern, getPosit, getPotentialForceDirection, getPotentialForceDirection, getPotentialForceDirection, getStandoff, getXPosit, getYPosit, setStandoff

Methods inherited from class java.lang.Object

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

Constructor Detail

VehicleObject

public VehicleObject(double x,
             double y,
             double direction,
             double speed,
             double time,
             double standoff,
             int VID)

Constructor

Parameters:

x - north/south Cartesian coordinate of the object's location in the world

y - east/west Cartesian coordinate of the object's location in the world

direction - direction (degrees) that the object is moving

speed - speed at which the object is moving (m/sec)

time - mission time (secs from mission start) that the object is first entered into the system

standoff - required distance (meters) that the vehicle must remain clear from this object

VID - a unique identifier for this vehicle object

VehicleObject

public VehicleObject(double[] position,
             double direction,
             double speed,
             double time,
             double standoff,
             int VID)

Constructor

Parameters:

position - 2-element array with the Cartesian coordinates of the object's location in the world

direction - direction (degrees) that the object is moving

speed - speed at which the object is moving (m/sec)

time - mission time (secs from mission start) that the object is first entered into the system

standoff - required distance (meters) that the vehicle must remain clear from this object

VID - a unique identifier for this vehicle object

VehicleObject

public VehicleObject(Point position,
             double direction,
             double speed,
             double time,
             double standoff,
             int VID)

Constructor

Parameters:

position - 2-element array with the Cartesian coordinates of the object's location in the world

direction - direction (degrees) that the object is moving

speed - speed at which the object is moving (m/sec)

time - mission time (secs from mission start) that the object is first entered into the system

standoff - required distance (meters) that the vehicle must remain clear from this object

VID - a unique identifier for this vehicle object

VehicleObject

public VehicleObject(double time,
             double standoff,
             int VID)

Constructor for a zero-velocity vehicle that will be placed at the origin with zero velocity

Parameters:

time - mission time (secs from mission start) that the object is first entered into the system

standoff - required distance (meters) that the vehicle must remain clear from this object

VID - a unique identifier for this vehicle object

Method Detail

setParticipating

public void setParticipating(boolean isParticipating)

Sets the vehicle as participating (true) or not (false) in the owning vehicle's group

Parameters:

isParticipating - is in the group (true) or not in the group (false)

isParticipating

public boolean isParticipating()

Returns:

whether or not the vehicle is participating in the same group as the owning vehicle

getVehicleType

public int getVehicleType()

Returns:

an enumeration for the type of vehicle

setVID

public void setVID(int newID)

Sets the vehicle as participating (true) or not (false) in the owning vehicle's group

Parameters:

newID - is in the group (true) or not in the group (false)

getVID

public Integer getVID()

Returns:

the (hopefully) unique identifier for this vehicle

setCapabilities

public void setCapabilities(AvclMessage msg)

Uses an AVCL Characteristics message to set the vehicle operating limits and capabilities

Parameters:

msg - an AVCLMessage object containing a "Characteristics" message

canCompleteGoal

public boolean canCompleteGoal(int goalType)

Queries whether the vehicle is capable of completing a specified goal type

Parameters:

goalType - identifying the goal type

Returns:

true if the vehicle is capable of completing goals of the specified type

getCharacteristic

public String getCharacteristic(int charNum)

Returns a String describing a special capability or characteristic of the vehicle

Parameters:

charNum - index into the list of capabilities

Returns:

String

hasCharacteristic

public boolean hasCharacteristic(String chr)

Does the vehicle have a specific characteristic

Parameters:

chr - string representing the characteristic being queried for

Returns:

true if the vehicle has the characteristic

compareTo

public int compareTo(VehicleObject v2)

Implements the Comparable interface

Specified by:

compareTo in interface Comparable<VehicleObject>

Parameters:

v2 -

toString

public String toString()

Generates a string representation of the wall object

Overrides:

toString in class MovingObject