com.jayfella.jme.vehicle.part

Class GearBox

java.lang.Object

com.jayfella.jme.vehicle.part.GearBox

public class GearBox
extends java.lang.Object

The gearbox (or transmission) of a Vehicle, including the differential. Derived from the GearBox class in the Advanced Vehicles project.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Logger	logger message logger for this class

Constructor Summary

Constructors

Constructor and Description
GearBox(int numForwardGears, int numReverseGears) Instantiate a GearBox with the specified numbers of gears.

Method Summary

Modifier and Type	Method and Description
int	countForwardGears() Count the forward gears.
int	countReverseGears() Count the reverse gears.
void	engageGearNum(int gearNum) Alter which gear is engaged.
Gear	getEngagedGear() Access the Gear that's currently engaged.
int	getEngagedGearNum() Determine which Gear is currently engaged.
Gear	getGear(int gearNum) Access a gear by number.
boolean	isInReverse() Test whether this GearBox is in reverse.
java.util.List<java.lang.String>	listAutomaticModes() Enumerate all available modes of the automatic transmission.
float	maxForwardSpeed(SpeedUnit speedUnit) Determine the maximum forward speed.
float	maxReverseSpeed(SpeedUnit speedUnit) Determine the maximum reverse speed.
void	setReversing(boolean reverse) Convenience method to switch between forward and reverse.

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final java.util.logging.Logger logger

message logger for this class

Constructor Detail

GearBox

public GearBox(int numForwardGears,
               int numReverseGears)

Instantiate a GearBox with the specified numbers of gears.

Parameters:

numForwardGears - the number of forward gears (≥1)

numReverseGears - the number of reverse gears (≥0, typically 1)

Method Detail

countForwardGears

public int countForwardGears()

Count the forward gears.

Returns:

the count (>0)

countReverseGears

public int countReverseGears()

Count the reverse gears.

Returns:

the count (≥0)

engageGearNum

public void engageGearNum(int gearNum)

Alter which gear is engaged.

Parameters:

gearNum - the number of the desired gear

getEngagedGear

public Gear getEngagedGear()

Access the Gear that's currently engaged.

Returns:

the pre-existing instance (not null)

getEngagedGearNum

public int getEngagedGearNum()

Determine which Gear is currently engaged.

Returns:

the number of the gear

getGear

public Gear getGear(int gearNum)

Access a gear by number.

Parameters:

gearNum - the number of the gear

Returns:

the pre-existing instance (not null)

isInReverse

public boolean isInReverse()

Test whether this GearBox is in reverse.

Returns:

true if a reverse gear is engaged, otherwise false

listAutomaticModes

public java.util.List<java.lang.String> listAutomaticModes()

Enumerate all available modes of the automatic transmission.

Returns:

an unmodifiable list of names, in top-to-bottom order (not null)

maxForwardSpeed

public float maxForwardSpeed(SpeedUnit speedUnit)

Determine the maximum forward speed.

Parameters:

speedUnit - (not null)

Returns:

the tread speed (>0, in the specified units)

maxReverseSpeed

public float maxReverseSpeed(SpeedUnit speedUnit)

Determine the maximum reverse speed.

Parameters:

speedUnit - (not null)

Returns:

the tread speed (<0, in the specified units)

setReversing

public void setReversing(boolean reverse)

Convenience method to switch between forward and reverse.

Parameters:

reverse - true for reverse, false for forward