edu.nps.moves.disenum.DriveTrain Maven / Gradle / Ivy
Show all versions of dis-enums Show documentation
package edu.nps.moves.disenum;
import java.util.HashMap;
import edu.nps.moves.siso.EnumNotFoundException;
/** Enumeration values for DriveTrain
* The enumeration values are generated from the SISO DIS XML EBV document (R35), which was
* obtained from http://discussions.sisostds.org/default.asp?action=10&fd=31
*
* Note that this has two ways to look up an enumerated instance from a value: a fast
* but brittle array lookup, and a slower and more garbage-intensive, but safer, method.
* if you want to minimize memory use, get rid of one or the other.
*
* Copyright 2008-2009. This work is licensed under the BSD license, available at
* http://www.movesinstitute.org/licenses
*
* @author DMcG, Jason Nelson
*/
public enum DriveTrain
{
MOTOR_ENGINE(10, "motor / engine"),
STARTER(20, "starter"),
ALTERNATOR(30, "alternator"),
GENERATOR(40, "generator"),
BATTERY(50, "battery"),
ENGINE_COOLANT_LEAK(60, "engine-coolant leak"),
FUEL_FILTER(70, "fuel filter"),
TRANSMISSION_OIL_LEAK(80, "transmission-oil leak"),
ENGINE_OIL_LEAK(90, "engine-oil leak"),
PUMPS(100, "pumps"),
FILTERS(110, "filters"),
TRANSMISSION(120, "transmission"),
BRAKES(130, "brakes"),
SUSPENSION_SYSTEM(140, "suspension system"),
OIL_FILTER(150, "oil filter"),
MISSING_DESCRIPTION(160, "Missing Description");
/** The enumerated value */
public final int value;
/** Text/english description of the enumerated value */
public final String description;
/** This is an array, with each slot corresponding to an enumerated value. This is a fast but brittle way to look up
* enumerated values. If there is no enumeration corresponding to the value it will fail, and it will also fail if the
* index it out of range of the array. But it is fast, and generates less garbage than the alternative of using
* getEnumerationForValue(). It should be used only in real-time environments, and be careful even then.
* Use as DriveTrain.lookup[aVal] to get the enumeration that corresponds to a value.
* In non-realtime environments, the prefered method is getEnumerationForValue().
*/
static public DriveTrain lookup[] = new DriveTrain[161];
static private HashMapenumerations = new HashMap();
/* initialize the array and hash table at class load time */
static
{
for(DriveTrain anEnum:DriveTrain.values())
{
lookup[anEnum.value] = anEnum;
enumerations.put(new Integer(anEnum.getValue()), anEnum);
}
}
/** Constructor */
DriveTrain(int value, String description)
{
this.value = value;
this.description = description;
}
/** Returns the string description associated with the enumerated instance with this value.
* If there is no enumerated instance for this value, the string Invalid enumeration: is returned.
*/
static public String getDescriptionForValue(int aVal)
{
String desc;
DriveTrain val = enumerations.get(new Integer(aVal));
if(val == null)
desc = "Invalid enumeration: " + (new Integer(aVal)).toString();
else
desc = val.getDescription();
return desc;
}
/** Returns the enumerated instance with this value.
* If there is no enumerated instance for this value, the exception is thrown.
*/
static public DriveTrain getEnumerationForValue(int aVal) throws EnumNotFoundException
{
DriveTrain val;
val = enumerations.get(new Integer(aVal));
if(val == null)
throw new EnumNotFoundException("no enumeration found for value " + aVal + " of enumeration DriveTrain");
return val;
}
/** Returns true if there is an enumerated instance for this value, false otherwise.
*/
static public boolean enumerationForValueExists(int aVal)
{
DriveTrain val;
val = enumerations.get(new Integer(aVal));
if(val == null)
return false;
return true;
}
/** Returns the enumerated value for this enumeration */
public int getValue()
{
return value;
}
/** Returns a text descriptioni for this enumerated value. This is usually used as the basis for the enumeration name. */
public String getDescription()
{
return description;
}
}