git.gag.com Git - debian/openrocket/blob - core/src/net/sf/openrocket/simulation/FlightDataType.java

   1 package net.sf.openrocket.simulation;
   2
   3 import java.util.HashMap;
   4 import java.util.Map;
   5
   6 import net.sf.openrocket.l10n.Translator;
   7 import net.sf.openrocket.startup.Application;
   8 import net.sf.openrocket.unit.UnitGroup;
   9
  10 /**
  11  * A class defining a storable simulation variable type.  This class defined numerous ready
  12  * types, and allows also creating new types with any name.  When retrieving types based on
  13  * a name, you should use {@link #getType(String, UnitGroup)} to return the default unit type,
  14  * or a new type if the name does not currently exist.
  15  * <p>
  16  * Each type has a type name (description), a unit group and a priority.  The type is identified
  17  * purely by its name case-insensitively.  The unit group provides the units for the type.
  18  * The priority is used to order the types.  The pre-existing types are defined specific priority
  19  * numbers, and other types have a default priority number that is after all other types.
  20  *
  21  * @author Sampo Niskanen <sampo.niskanen@iki.fi>
  22  */
  23 public class FlightDataType implements Comparable<FlightDataType> {
  24         private static final Translator trans = Application.getTranslator();
  25
  26         /** Priority of custom-created variables */
  27         private static final int DEFAULT_PRIORITY = 999;
  28
  29         /** List of existing types.  MUST BE DEFINED BEFORE ANY TYPES!! */
  30         private static final Map<String, FlightDataType> EXISTING_TYPES = new HashMap<String, FlightDataType>();
  31
  32
  33
  34         //// Time
  35         public static final FlightDataType TYPE_TIME = newType(trans.get("FlightDataType.TYPE_TIME"), UnitGroup.UNITS_FLIGHT_TIME, 1);
  36
  37
  38         //// Vertical position and motion
  39         //// Altitude
  40         public static final FlightDataType TYPE_ALTITUDE = newType(trans.get("FlightDataType.TYPE_ALTITUDE"), UnitGroup.UNITS_DISTANCE, 10);
  41         //// Vertical velocity
  42         public static final FlightDataType TYPE_VELOCITY_Z = newType(trans.get("FlightDataType.TYPE_VELOCITY_Z"), UnitGroup.UNITS_VELOCITY, 11);
  43         //// Vertical acceleration
  44         public static final FlightDataType TYPE_ACCELERATION_Z = newType(trans.get("FlightDataType.TYPE_ACCELERATION_Z"), UnitGroup.UNITS_ACCELERATION, 12);
  45
  46
  47         //// Total motion
  48         //// Total velocity
  49         public static final FlightDataType TYPE_VELOCITY_TOTAL = newType(trans.get("FlightDataType.TYPE_VELOCITY_TOTAL"), UnitGroup.UNITS_VELOCITY, 20);
  50         //// Total acceleration
  51         public static final FlightDataType TYPE_ACCELERATION_TOTAL = newType(trans.get("FlightDataType.TYPE_ACCELERATION_TOTAL"), UnitGroup.UNITS_ACCELERATION, 21);
  52
  53
  54         //// Lateral position and motion
  55         //// Position upwind
  56         public static final FlightDataType TYPE_POSITION_X = newType(trans.get("FlightDataType.TYPE_POSITION_X"), UnitGroup.UNITS_DISTANCE, 30);
  57         //// Position parallel to wind
  58         public static final FlightDataType TYPE_POSITION_Y = newType(trans.get("FlightDataType.TYPE_POSITION_Y"), UnitGroup.UNITS_DISTANCE, 31);
  59         //// Lateral distance
  60         public static final FlightDataType TYPE_POSITION_XY = newType(trans.get("FlightDataType.TYPE_POSITION_XY"), UnitGroup.UNITS_DISTANCE, 32);
  61         //// Lateral direction
  62         public static final FlightDataType TYPE_POSITION_DIRECTION = newType(trans.get("FlightDataType.TYPE_POSITION_DIRECTION"), UnitGroup.UNITS_ANGLE, 33);
  63         //// Lateral velocity
  64         public static final FlightDataType TYPE_VELOCITY_XY = newType(trans.get("FlightDataType.TYPE_VELOCITY_XY"), UnitGroup.UNITS_VELOCITY, 34);
  65         //// Lateral acceleration
  66         public static final FlightDataType TYPE_ACCELERATION_XY = newType(trans.get("FlightDataType.TYPE_ACCELERATION_XY"), UnitGroup.UNITS_ACCELERATION, 35);
  67         //// Latitude
  68         public static final FlightDataType TYPE_LATITUDE = newType(trans.get("FlightDataType.TYPE_LATITUDE"), UnitGroup.UNITS_ANGLE, 36);
  69         //// Longitude
  70         public static final FlightDataType TYPE_LONGITUDE = newType(trans.get("FlightDataType.TYPE_LONGITUDE"), UnitGroup.UNITS_ANGLE, 37);
  71
  72         //// Angular motion
  73         //// Angle of attack
  74         public static final FlightDataType TYPE_AOA = newType(trans.get("FlightDataType.TYPE_AOA"), UnitGroup.UNITS_ANGLE, 40);
  75         //// Roll rate
  76         public static final FlightDataType TYPE_ROLL_RATE = newType(trans.get("FlightDataType.TYPE_ROLL_RATE"), UnitGroup.UNITS_ROLL, 41);
  77         //// Pitch rate
  78         public static final FlightDataType TYPE_PITCH_RATE = newType(trans.get("FlightDataType.TYPE_PITCH_RATE"), UnitGroup.UNITS_ROLL, 42);
  79         //// Yaw rate
  80         public static final FlightDataType TYPE_YAW_RATE = newType(trans.get("FlightDataType.TYPE_YAW_RATE"), UnitGroup.UNITS_ROLL, 43);
  81
  82
  83         //// Stability information
  84         //// Mass
  85         public static final FlightDataType TYPE_MASS = newType(trans.get("FlightDataType.TYPE_MASS"), UnitGroup.UNITS_MASS, 50);
  86         //// Longitudinal moment of inertia
  87         public static final FlightDataType TYPE_LONGITUDINAL_INERTIA = newType(trans.get("FlightDataType.TYPE_LONGITUDINAL_INERTIA"), UnitGroup.UNITS_INERTIA, 51);
  88         //// Rotational moment of inertia
  89         public static final FlightDataType TYPE_ROTATIONAL_INERTIA = newType(trans.get("FlightDataType.TYPE_ROTATIONAL_INERTIA"), UnitGroup.UNITS_INERTIA, 52);
  90         //// CP location
  91         public static final FlightDataType TYPE_CP_LOCATION = newType(trans.get("FlightDataType.TYPE_CP_LOCATION"), UnitGroup.UNITS_LENGTH, 53);
  92         //// CG location
  93         public static final FlightDataType TYPE_CG_LOCATION = newType(trans.get("FlightDataType.TYPE_CG_LOCATION"), UnitGroup.UNITS_LENGTH, 54);
  94         //// Stability margin calibers
  95         public static final FlightDataType TYPE_STABILITY = newType(trans.get("FlightDataType.TYPE_STABILITY"), UnitGroup.UNITS_COEFFICIENT, 55);
  96
  97
  98         //// Characteristic numbers
  99         //// Mach number
 100         public static final FlightDataType TYPE_MACH_NUMBER = newType(trans.get("FlightDataType.TYPE_MACH_NUMBER"), UnitGroup.UNITS_COEFFICIENT, 60);
 101         //// Reynolds number
 102         public static final FlightDataType TYPE_REYNOLDS_NUMBER = newType(trans.get("FlightDataType.TYPE_REYNOLDS_NUMBER"), UnitGroup.UNITS_COEFFICIENT, 61);
 103
 104
 105         //// Thrust and drag
 106         //// Thrust
 107         public static final FlightDataType TYPE_THRUST_FORCE = newType(trans.get("FlightDataType.TYPE_THRUST_FORCE"), UnitGroup.UNITS_FORCE, 70);
 108         //// Drag force
 109         public static final FlightDataType TYPE_DRAG_FORCE = newType(trans.get("FlightDataType.TYPE_DRAG_FORCE"), UnitGroup.UNITS_FORCE, 71);
 110         //// Drag coefficient
 111         public static final FlightDataType TYPE_DRAG_COEFF = newType(trans.get("FlightDataType.TYPE_DRAG_COEFF"), UnitGroup.UNITS_COEFFICIENT, 72);
 112         //// Axial drag coefficient
 113         public static final FlightDataType TYPE_AXIAL_DRAG_COEFF = newType(trans.get("FlightDataType.TYPE_AXIAL_DRAG_COEFF"), UnitGroup.UNITS_COEFFICIENT, 73);
 114
 115
 116         ////  Component drag coefficients
 117         //// Friction drag coefficient
 118         public static final FlightDataType TYPE_FRICTION_DRAG_COEFF = newType(trans.get("FlightDataType.TYPE_FRICTION_DRAG_COEFF"), UnitGroup.UNITS_COEFFICIENT, 80);
 119         //// Pressure drag coefficient
 120         public static final FlightDataType TYPE_PRESSURE_DRAG_COEFF = newType(trans.get("FlightDataType.TYPE_PRESSURE_DRAG_COEFF"), UnitGroup.UNITS_COEFFICIENT, 81);
 121         //// Base drag coefficient
 122         public static final FlightDataType TYPE_BASE_DRAG_COEFF = newType(trans.get("FlightDataType.TYPE_BASE_DRAG_COEFF"), UnitGroup.UNITS_COEFFICIENT, 82);
 123
 124
 125         ////  Other coefficients
 126         //// Normal force coefficient
 127         public static final FlightDataType TYPE_NORMAL_FORCE_COEFF = newType(trans.get("FlightDataType.TYPE_NORMAL_FORCE_COEFF"), UnitGroup.UNITS_COEFFICIENT, 90);
 128         //// Pitch moment coefficient
 129         public static final FlightDataType TYPE_PITCH_MOMENT_COEFF = newType(trans.get("FlightDataType.TYPE_PITCH_MOMENT_COEFF"), UnitGroup.UNITS_COEFFICIENT, 91);
 130         //// Yaw moment coefficient
 131         public static final FlightDataType TYPE_YAW_MOMENT_COEFF = newType(trans.get("FlightDataType.TYPE_YAW_MOMENT_COEFF"), UnitGroup.UNITS_COEFFICIENT, 92);
 132         //// Side force coefficient
 133         public static final FlightDataType TYPE_SIDE_FORCE_COEFF = newType(trans.get("FlightDataType.TYPE_SIDE_FORCE_COEFF"), UnitGroup.UNITS_COEFFICIENT, 93);
 134         //// Roll moment coefficient
 135         public static final FlightDataType TYPE_ROLL_MOMENT_COEFF = newType(trans.get("FlightDataType.TYPE_ROLL_MOMENT_COEFF"), UnitGroup.UNITS_COEFFICIENT, 94);
 136         //// Roll forcing coefficient
 137         public static final FlightDataType TYPE_ROLL_FORCING_COEFF = newType(trans.get("FlightDataType.TYPE_ROLL_FORCING_COEFF"), UnitGroup.UNITS_COEFFICIENT, 95);
 138         //// Roll damping coefficient
 139         public static final FlightDataType TYPE_ROLL_DAMPING_COEFF = newType(trans.get("FlightDataType.TYPE_ROLL_DAMPING_COEFF"), UnitGroup.UNITS_COEFFICIENT, 96);
 140
 141         //// Pitch damping coefficient
 142         public static final FlightDataType TYPE_PITCH_DAMPING_MOMENT_COEFF = newType(trans.get("FlightDataType.TYPE_PITCH_DAMPING_MOMENT_COEFF"), UnitGroup.UNITS_COEFFICIENT, 97);
 143         //// Yaw damping coefficient
 144         public static final FlightDataType TYPE_YAW_DAMPING_MOMENT_COEFF = newType(trans.get("FlightDataType.TYPE_YAW_DAMPING_MOMENT_COEFF"), UnitGroup.UNITS_COEFFICIENT, 98);
 145
 146         //// Coriolis acceleration
 147         public static final FlightDataType TYPE_CORIOLIS_ACCELERATION = newType(trans.get("FlightDataType.TYPE_CORIOLIS_ACCELERATION"), UnitGroup.UNITS_ACCELERATION, 99);
 148
 149
 150         ////  Reference length + area
 151         //// Reference length
 152         public static final FlightDataType TYPE_REFERENCE_LENGTH = newType(trans.get("FlightDataType.TYPE_REFERENCE_LENGTH"), UnitGroup.UNITS_LENGTH, 100);
 153         //// Reference area
 154         public static final FlightDataType TYPE_REFERENCE_AREA = newType(trans.get("FlightDataType.TYPE_REFERENCE_AREA"), UnitGroup.UNITS_AREA, 101);
 155
 156
 157         ////  Orientation
 158         //// Vertical orientation (zenith)
 159         public static final FlightDataType TYPE_ORIENTATION_THETA = newType(trans.get("FlightDataType.TYPE_ORIENTATION_THETA"), UnitGroup.UNITS_ANGLE, 106);
 160         //// Lateral orientation (azimuth)
 161         public static final FlightDataType TYPE_ORIENTATION_PHI = newType(trans.get("FlightDataType.TYPE_ORIENTATION_PHI"), UnitGroup.UNITS_ANGLE, 107);
 162
 163
 164         ////  Atmospheric conditions
 165         //// Wind velocity
 166         public static final FlightDataType TYPE_WIND_VELOCITY = newType(trans.get("FlightDataType.TYPE_WIND_VELOCITY"), UnitGroup.UNITS_VELOCITY, 110);
 167         //// Air temperature
 168         public static final FlightDataType TYPE_AIR_TEMPERATURE = newType(trans.get("FlightDataType.TYPE_AIR_TEMPERATURE"), UnitGroup.UNITS_TEMPERATURE, 111);
 169         //// Air pressure
 170         public static final FlightDataType TYPE_AIR_PRESSURE = newType(trans.get("FlightDataType.TYPE_AIR_PRESSURE"), UnitGroup.UNITS_PRESSURE, 112);
 171         //// Speed of sound
 172         public static final FlightDataType TYPE_SPEED_OF_SOUND = newType(trans.get("FlightDataType.TYPE_SPEED_OF_SOUND"), UnitGroup.UNITS_VELOCITY, 113);
 173
 174         ////  Simulation information
 175         //// Simulation time step
 176         public static final FlightDataType TYPE_TIME_STEP = newType(trans.get("FlightDataType.TYPE_TIME_STEP"), UnitGroup.UNITS_TIME_STEP, 200);
 177         //// Computation time
 178         public static final FlightDataType TYPE_COMPUTATION_TIME = newType(trans.get("FlightDataType.TYPE_COMPUTATION_TIME"), UnitGroup.UNITS_SHORT_TIME, 201);
 179
 180
 181
 182         /**
 183          * Return a {@link FlightDataType} based on a string description.  This returns known data types
 184          * if possible, or a new type otherwise.
 185          *
 186          * @param s             the string description of the type.
 187          * @param u             the unit group the new type should belong to if a new group is created.
 188          * @return              a data type.
 189          */
 190         public static synchronized FlightDataType getType(String s, UnitGroup u) {
 191                 FlightDataType type = EXISTING_TYPES.get(s.toLowerCase());
 192                 if (type != null) {
 193                         return type;
 194                 }
 195                 type = newType(s, u, DEFAULT_PRIORITY);
 196                 return type;
 197         }
 198
 199         /**
 200          * Used while initializing the class.
 201          */
 202         private static synchronized FlightDataType newType(String s, UnitGroup u, int priority) {
 203                 FlightDataType type = new FlightDataType(s, u, priority);
 204                 EXISTING_TYPES.put(s.toLowerCase(), type);
 205                 return type;
 206         }
 207
 208
 209         private final String name;
 210         private final UnitGroup units;
 211         private final int priority;
 212         private final int hashCode;
 213
 214
 215         private FlightDataType(String typeName, UnitGroup units, int priority) {
 216                 if (typeName == null)
 217                         throw new IllegalArgumentException("typeName is null");
 218                 if (units == null)
 219                         throw new IllegalArgumentException("units is null");
 220                 this.name = typeName;
 221                 this.units = units;
 222                 this.priority = priority;
 223                 this.hashCode = this.name.toLowerCase().hashCode();
 224         }
 225
 226
 227
 228
 229         public String getName() {
 230                 return name;
 231         }
 232
 233         public UnitGroup getUnitGroup() {
 234                 return units;
 235         }
 236
 237         @Override
 238         public String toString() {
 239                 return name;
 240         }
 241
 242         @Override
 243         public boolean equals(Object other) {
 244                 if (!(other instanceof FlightDataType))
 245                         return false;
 246                 return this.name.equalsIgnoreCase(((FlightDataType) other).name);
 247         }
 248
 249         @Override
 250         public int hashCode() {
 251                 return hashCode;
 252         }
 253
 254         @Override
 255         public int compareTo(FlightDataType o) {
 256                 if (this.priority != o.priority)
 257                         return this.priority - o.priority;
 258                 return this.name.compareToIgnoreCase(o.name);
 259         }
 260 }