1 package net.sf.openrocket.file.openrocket.importt;
3 import java.io.IOException;
4 import java.io.InputStream;
5 import java.lang.reflect.Constructor;
6 import java.lang.reflect.InvocationTargetException;
7 import java.util.ArrayList;
8 import java.util.HashMap;
10 import java.util.Locale;
11 import java.util.regex.Matcher;
12 import java.util.regex.Pattern;
14 import net.sf.openrocket.aerodynamics.Warning;
15 import net.sf.openrocket.aerodynamics.WarningSet;
16 import net.sf.openrocket.database.Databases;
17 import net.sf.openrocket.document.OpenRocketDocument;
18 import net.sf.openrocket.document.Simulation;
19 import net.sf.openrocket.document.Simulation.Status;
20 import net.sf.openrocket.document.StorageOptions;
21 import net.sf.openrocket.file.AbstractRocketLoader;
22 import net.sf.openrocket.file.MotorFinder;
23 import net.sf.openrocket.file.RocketLoadException;
24 import net.sf.openrocket.file.simplesax.AbstractElementHandler;
25 import net.sf.openrocket.file.simplesax.ElementHandler;
26 import net.sf.openrocket.file.simplesax.PlainTextHandler;
27 import net.sf.openrocket.file.simplesax.SimpleSAX;
28 import net.sf.openrocket.logging.LogHelper;
29 import net.sf.openrocket.material.Material;
30 import net.sf.openrocket.motor.Motor;
31 import net.sf.openrocket.preset.ComponentPreset;
32 import net.sf.openrocket.rocketcomponent.BodyComponent;
33 import net.sf.openrocket.rocketcomponent.BodyTube;
34 import net.sf.openrocket.rocketcomponent.Bulkhead;
35 import net.sf.openrocket.rocketcomponent.CenteringRing;
36 import net.sf.openrocket.rocketcomponent.ClusterConfiguration;
37 import net.sf.openrocket.rocketcomponent.Clusterable;
38 import net.sf.openrocket.rocketcomponent.EllipticalFinSet;
39 import net.sf.openrocket.rocketcomponent.EngineBlock;
40 import net.sf.openrocket.rocketcomponent.ExternalComponent;
41 import net.sf.openrocket.rocketcomponent.ExternalComponent.Finish;
42 import net.sf.openrocket.rocketcomponent.FinSet;
43 import net.sf.openrocket.rocketcomponent.FinSet.TabRelativePosition;
44 import net.sf.openrocket.rocketcomponent.FreeformFinSet;
45 import net.sf.openrocket.rocketcomponent.IllegalFinPointException;
46 import net.sf.openrocket.rocketcomponent.InnerTube;
47 import net.sf.openrocket.rocketcomponent.InternalComponent;
48 import net.sf.openrocket.rocketcomponent.LaunchLug;
49 import net.sf.openrocket.rocketcomponent.MassComponent;
50 import net.sf.openrocket.rocketcomponent.MassObject;
51 import net.sf.openrocket.rocketcomponent.MotorMount;
52 import net.sf.openrocket.rocketcomponent.NoseCone;
53 import net.sf.openrocket.rocketcomponent.Parachute;
54 import net.sf.openrocket.rocketcomponent.RadiusRingComponent;
55 import net.sf.openrocket.rocketcomponent.RecoveryDevice;
56 import net.sf.openrocket.rocketcomponent.ReferenceType;
57 import net.sf.openrocket.rocketcomponent.RingComponent;
58 import net.sf.openrocket.rocketcomponent.Rocket;
59 import net.sf.openrocket.rocketcomponent.RocketComponent;
60 import net.sf.openrocket.rocketcomponent.RocketComponent.Position;
61 import net.sf.openrocket.rocketcomponent.ShockCord;
62 import net.sf.openrocket.rocketcomponent.Stage;
63 import net.sf.openrocket.rocketcomponent.Streamer;
64 import net.sf.openrocket.rocketcomponent.StructuralComponent;
65 import net.sf.openrocket.rocketcomponent.SymmetricComponent;
66 import net.sf.openrocket.rocketcomponent.ThicknessRingComponent;
67 import net.sf.openrocket.rocketcomponent.Transition;
68 import net.sf.openrocket.rocketcomponent.TrapezoidFinSet;
69 import net.sf.openrocket.rocketcomponent.TubeCoupler;
70 import net.sf.openrocket.simulation.CustomExpression;
71 import net.sf.openrocket.simulation.FlightData;
72 import net.sf.openrocket.simulation.FlightDataBranch;
73 import net.sf.openrocket.simulation.FlightDataType;
74 import net.sf.openrocket.simulation.FlightEvent;
75 import net.sf.openrocket.simulation.FlightEvent.Type;
76 import net.sf.openrocket.simulation.SimulationOptions;
77 import net.sf.openrocket.startup.Application;
78 import net.sf.openrocket.unit.UnitGroup;
79 import net.sf.openrocket.util.BugException;
80 import net.sf.openrocket.util.Color;
81 import net.sf.openrocket.util.Coordinate;
82 import net.sf.openrocket.util.GeodeticComputationStrategy;
83 import net.sf.openrocket.util.LineStyle;
84 import net.sf.openrocket.util.Reflection;
86 import org.xml.sax.InputSource;
87 import org.xml.sax.SAXException;
91 * Class that loads a rocket definition from an OpenRocket rocket file.
93 * This class uses SAX to read the XML file format. The
94 * #loadFromStream(InputStream) method simply sets the system up and
95 * starts the parsing, while the actual logic is in the private inner class
96 * <code>OpenRocketHandler</code>.
98 * @author Sampo Niskanen <sampo.niskanen@iki.fi>
100 public class OpenRocketLoader extends AbstractRocketLoader {
101 private static final LogHelper log = Application.getLogger();
105 public OpenRocketDocument loadFromStream(InputStream source, MotorFinder motorFinder) throws RocketLoadException,
107 log.info("Loading .ork file");
108 DocumentLoadingContext context = new DocumentLoadingContext();
109 context.setMotorFinder(motorFinder);
111 InputSource xmlSource = new InputSource(source);
112 OpenRocketHandler handler = new OpenRocketHandler(context);
116 SimpleSAX.readXML(xmlSource, handler, warnings);
117 } catch (SAXException e) {
118 log.warn("Malformed XML in input");
119 throw new RocketLoadException("Malformed XML in input.", e);
123 OpenRocketDocument doc = handler.getDocument();
124 doc.getDefaultConfiguration().setAllStages();
126 // Deduce suitable time skip
127 double timeSkip = StorageOptions.SIMULATION_DATA_NONE;
128 for (Simulation s : doc.getSimulations()) {
129 if (s.getStatus() == Simulation.Status.EXTERNAL ||
130 s.getStatus() == Simulation.Status.NOT_SIMULATED)
132 if (s.getSimulatedData() == null)
134 if (s.getSimulatedData().getBranchCount() == 0)
136 FlightDataBranch branch = s.getSimulatedData().getBranch(0);
139 List<Double> list = branch.get(FlightDataType.TYPE_TIME);
143 double previousTime = Double.NaN;
144 for (double time : list) {
145 if (time - previousTime < timeSkip)
146 timeSkip = time - previousTime;
151 timeSkip = Math.rint(timeSkip * 100) / 100;
153 doc.getDefaultStorageOptions().setSimulationTimeSkip(timeSkip);
154 doc.getDefaultStorageOptions().setCompressionEnabled(false); // Set by caller if compressed
155 doc.getDefaultStorageOptions().setExplicitlySet(false);
158 log.info("Loading done");
166 class DocumentConfig {
168 /* Remember to update OpenRocketSaver as well! */
169 public static final String[] SUPPORTED_VERSIONS = { "1.0", "1.1", "1.2", "1.3", "1.4", "1.5" };
172 * Divisor used in converting an integer version to the point-represented version.
173 * The integer version divided by this value is the major version and the remainder is
174 * the minor version. For example 101 corresponds to file version "1.1".
176 public static final int FILE_VERSION_DIVISOR = 100;
179 //////// Component constructors
180 static final HashMap<String, Constructor<? extends RocketComponent>> constructors = new HashMap<String, Constructor<? extends RocketComponent>>();
183 // External components
184 constructors.put("bodytube", BodyTube.class.getConstructor(new Class<?>[0]));
185 constructors.put("transition", Transition.class.getConstructor(new Class<?>[0]));
186 constructors.put("nosecone", NoseCone.class.getConstructor(new Class<?>[0]));
187 constructors.put("trapezoidfinset", TrapezoidFinSet.class.getConstructor(new Class<?>[0]));
188 constructors.put("ellipticalfinset", EllipticalFinSet.class.getConstructor(new Class<?>[0]));
189 constructors.put("freeformfinset", FreeformFinSet.class.getConstructor(new Class<?>[0]));
190 constructors.put("launchlug", LaunchLug.class.getConstructor(new Class<?>[0]));
192 // Internal components
193 constructors.put("engineblock", EngineBlock.class.getConstructor(new Class<?>[0]));
194 constructors.put("innertube", InnerTube.class.getConstructor(new Class<?>[0]));
195 constructors.put("tubecoupler", TubeCoupler.class.getConstructor(new Class<?>[0]));
196 constructors.put("bulkhead", Bulkhead.class.getConstructor(new Class<?>[0]));
197 constructors.put("centeringring", CenteringRing.class.getConstructor(new Class<?>[0]));
199 constructors.put("masscomponent", MassComponent.class.getConstructor(new Class<?>[0]));
200 constructors.put("shockcord", ShockCord.class.getConstructor(new Class<?>[0]));
201 constructors.put("parachute", Parachute.class.getConstructor(new Class<?>[0]));
202 constructors.put("streamer", Streamer.class.getConstructor(new Class<?>[0]));
205 constructors.put("stage", Stage.class.getConstructor(new Class<?>[0]));
207 } catch (NoSuchMethodException e) {
208 throw new BugException(
209 "Error in constructing the 'constructors' HashMap.");
214 //////// Parameter setters
216 * The keys are of the form Class:param, where Class is the class name and param
217 * the element name. Setters are searched for in descending class order.
218 * A setter of null means setting the parameter is not allowed.
220 static final HashMap<String, Setter> setters = new HashMap<String, Setter>();
223 setters.put("RocketComponent:name", new StringSetter(
224 Reflection.findMethod(RocketComponent.class, "setName", String.class)));
225 setters.put("RocketComponent:color", new ColorSetter(
226 Reflection.findMethod(RocketComponent.class, "setColor", Color.class)));
227 setters.put("RocketComponent:linestyle", new EnumSetter<LineStyle>(
228 Reflection.findMethod(RocketComponent.class, "setLineStyle", LineStyle.class),
230 setters.put("RocketComponent:position", new PositionSetter());
231 setters.put("RocketComponent:overridemass", new OverrideSetter(
232 Reflection.findMethod(RocketComponent.class, "setOverrideMass", double.class),
233 Reflection.findMethod(RocketComponent.class, "setMassOverridden", boolean.class)));
234 setters.put("RocketComponent:overridecg", new OverrideSetter(
235 Reflection.findMethod(RocketComponent.class, "setOverrideCGX", double.class),
236 Reflection.findMethod(RocketComponent.class, "setCGOverridden", boolean.class)));
237 setters.put("RocketComponent:overridesubcomponents", new BooleanSetter(
238 Reflection.findMethod(RocketComponent.class, "setOverrideSubcomponents", boolean.class)));
239 setters.put("RocketComponent:comment", new StringSetter(
240 Reflection.findMethod(RocketComponent.class, "setComment", String.class)));
241 setters.put("RocketComponent:preset", new ComponentPresetSetter(
242 Reflection.findMethod(RocketComponent.class, "loadPreset", ComponentPreset.class)));
245 setters.put("ExternalComponent:finish", new EnumSetter<Finish>(
246 Reflection.findMethod(ExternalComponent.class, "setFinish", Finish.class),
248 setters.put("ExternalComponent:material", new MaterialSetter(
249 Reflection.findMethod(ExternalComponent.class, "setMaterial", Material.class),
250 Material.Type.BULK));
253 setters.put("BodyComponent:length", new DoubleSetter(
254 Reflection.findMethod(BodyComponent.class, "setLength", double.class)));
256 // SymmetricComponent
257 setters.put("SymmetricComponent:thickness", new DoubleSetter(
258 Reflection.findMethod(SymmetricComponent.class, "setThickness", double.class),
260 Reflection.findMethod(SymmetricComponent.class, "setFilled", boolean.class)));
263 setters.put("BodyTube:radius", new DoubleSetter(
264 Reflection.findMethod(BodyTube.class, "setOuterRadius", double.class),
266 Reflection.findMethod(BodyTube.class, "setOuterRadiusAutomatic", boolean.class)));
269 setters.put("Transition:shape", new EnumSetter<Transition.Shape>(
270 Reflection.findMethod(Transition.class, "setType", Transition.Shape.class),
271 Transition.Shape.class));
272 setters.put("Transition:shapeclipped", new BooleanSetter(
273 Reflection.findMethod(Transition.class, "setClipped", boolean.class)));
274 setters.put("Transition:shapeparameter", new DoubleSetter(
275 Reflection.findMethod(Transition.class, "setShapeParameter", double.class)));
277 setters.put("Transition:foreradius", new DoubleSetter(
278 Reflection.findMethod(Transition.class, "setForeRadius", double.class),
280 Reflection.findMethod(Transition.class, "setForeRadiusAutomatic", boolean.class)));
281 setters.put("Transition:aftradius", new DoubleSetter(
282 Reflection.findMethod(Transition.class, "setAftRadius", double.class),
284 Reflection.findMethod(Transition.class, "setAftRadiusAutomatic", boolean.class)));
286 setters.put("Transition:foreshoulderradius", new DoubleSetter(
287 Reflection.findMethod(Transition.class, "setForeShoulderRadius", double.class)));
288 setters.put("Transition:foreshoulderlength", new DoubleSetter(
289 Reflection.findMethod(Transition.class, "setForeShoulderLength", double.class)));
290 setters.put("Transition:foreshoulderthickness", new DoubleSetter(
291 Reflection.findMethod(Transition.class, "setForeShoulderThickness", double.class)));
292 setters.put("Transition:foreshouldercapped", new BooleanSetter(
293 Reflection.findMethod(Transition.class, "setForeShoulderCapped", boolean.class)));
295 setters.put("Transition:aftshoulderradius", new DoubleSetter(
296 Reflection.findMethod(Transition.class, "setAftShoulderRadius", double.class)));
297 setters.put("Transition:aftshoulderlength", new DoubleSetter(
298 Reflection.findMethod(Transition.class, "setAftShoulderLength", double.class)));
299 setters.put("Transition:aftshoulderthickness", new DoubleSetter(
300 Reflection.findMethod(Transition.class, "setAftShoulderThickness", double.class)));
301 setters.put("Transition:aftshouldercapped", new BooleanSetter(
302 Reflection.findMethod(Transition.class, "setAftShoulderCapped", boolean.class)));
304 // NoseCone - disable disallowed elements
305 setters.put("NoseCone:foreradius", null);
306 setters.put("NoseCone:foreshoulderradius", null);
307 setters.put("NoseCone:foreshoulderlength", null);
308 setters.put("NoseCone:foreshoulderthickness", null);
309 setters.put("NoseCone:foreshouldercapped", null);
312 setters.put("FinSet:fincount", new IntSetter(
313 Reflection.findMethod(FinSet.class, "setFinCount", int.class)));
314 setters.put("FinSet:rotation", new DoubleSetter(
315 Reflection.findMethod(FinSet.class, "setBaseRotation", double.class), Math.PI / 180.0));
316 setters.put("FinSet:thickness", new DoubleSetter(
317 Reflection.findMethod(FinSet.class, "setThickness", double.class)));
318 setters.put("FinSet:crosssection", new EnumSetter<FinSet.CrossSection>(
319 Reflection.findMethod(FinSet.class, "setCrossSection", FinSet.CrossSection.class),
320 FinSet.CrossSection.class));
321 setters.put("FinSet:cant", new DoubleSetter(
322 Reflection.findMethod(FinSet.class, "setCantAngle", double.class), Math.PI / 180.0));
323 setters.put("FinSet:tabheight", new DoubleSetter(
324 Reflection.findMethod(FinSet.class, "setTabHeight", double.class)));
325 setters.put("FinSet:tablength", new DoubleSetter(
326 Reflection.findMethod(FinSet.class, "setTabLength", double.class)));
327 setters.put("FinSet:tabposition", new FinTabPositionSetter());
330 setters.put("TrapezoidFinSet:rootchord", new DoubleSetter(
331 Reflection.findMethod(TrapezoidFinSet.class, "setRootChord", double.class)));
332 setters.put("TrapezoidFinSet:tipchord", new DoubleSetter(
333 Reflection.findMethod(TrapezoidFinSet.class, "setTipChord", double.class)));
334 setters.put("TrapezoidFinSet:sweeplength", new DoubleSetter(
335 Reflection.findMethod(TrapezoidFinSet.class, "setSweep", double.class)));
336 setters.put("TrapezoidFinSet:height", new DoubleSetter(
337 Reflection.findMethod(TrapezoidFinSet.class, "setHeight", double.class)));
340 setters.put("EllipticalFinSet:rootchord", new DoubleSetter(
341 Reflection.findMethod(EllipticalFinSet.class, "setLength", double.class)));
342 setters.put("EllipticalFinSet:height", new DoubleSetter(
343 Reflection.findMethod(EllipticalFinSet.class, "setHeight", double.class)));
345 // FreeformFinSet points handled as a special handler
348 setters.put("LaunchLug:radius", new DoubleSetter(
349 Reflection.findMethod(LaunchLug.class, "setOuterRadius", double.class)));
350 setters.put("LaunchLug:length", new DoubleSetter(
351 Reflection.findMethod(LaunchLug.class, "setLength", double.class)));
352 setters.put("LaunchLug:thickness", new DoubleSetter(
353 Reflection.findMethod(LaunchLug.class, "setThickness", double.class)));
354 setters.put("LaunchLug:radialdirection", new DoubleSetter(
355 Reflection.findMethod(LaunchLug.class, "setRadialDirection", double.class),
358 // InternalComponent - nothing
360 // StructuralComponent
361 setters.put("StructuralComponent:material", new MaterialSetter(
362 Reflection.findMethod(StructuralComponent.class, "setMaterial", Material.class),
363 Material.Type.BULK));
366 setters.put("RingComponent:length", new DoubleSetter(
367 Reflection.findMethod(RingComponent.class, "setLength", double.class)));
368 setters.put("RingComponent:radialposition", new DoubleSetter(
369 Reflection.findMethod(RingComponent.class, "setRadialPosition", double.class)));
370 setters.put("RingComponent:radialdirection", new DoubleSetter(
371 Reflection.findMethod(RingComponent.class, "setRadialDirection", double.class),
374 // ThicknessRingComponent - radius on separate components due to differing automatics
375 setters.put("ThicknessRingComponent:thickness", new DoubleSetter(
376 Reflection.findMethod(ThicknessRingComponent.class, "setThickness", double.class)));
379 setters.put("EngineBlock:outerradius", new DoubleSetter(
380 Reflection.findMethod(EngineBlock.class, "setOuterRadius", double.class),
382 Reflection.findMethod(EngineBlock.class, "setOuterRadiusAutomatic", boolean.class)));
385 setters.put("TubeCoupler:outerradius", new DoubleSetter(
386 Reflection.findMethod(TubeCoupler.class, "setOuterRadius", double.class),
388 Reflection.findMethod(TubeCoupler.class, "setOuterRadiusAutomatic", boolean.class)));
391 setters.put("InnerTube:outerradius", new DoubleSetter(
392 Reflection.findMethod(InnerTube.class, "setOuterRadius", double.class)));
393 setters.put("InnerTube:clusterconfiguration", new ClusterConfigurationSetter());
394 setters.put("InnerTube:clusterscale", new DoubleSetter(
395 Reflection.findMethod(InnerTube.class, "setClusterScale", double.class)));
396 setters.put("InnerTube:clusterrotation", new DoubleSetter(
397 Reflection.findMethod(InnerTube.class, "setClusterRotation", double.class),
400 // RadiusRingComponent
403 setters.put("RadiusRingComponent:innerradius", new DoubleSetter(
404 Reflection.findMethod(RadiusRingComponent.class, "setInnerRadius", double.class)));
405 setters.put("Bulkhead:outerradius", new DoubleSetter(
406 Reflection.findMethod(Bulkhead.class, "setOuterRadius", double.class),
408 Reflection.findMethod(Bulkhead.class, "setOuterRadiusAutomatic", boolean.class)));
411 setters.put("CenteringRing:innerradius", new DoubleSetter(
412 Reflection.findMethod(CenteringRing.class, "setInnerRadius", double.class),
414 Reflection.findMethod(CenteringRing.class, "setInnerRadiusAutomatic", boolean.class)));
415 setters.put("CenteringRing:outerradius", new DoubleSetter(
416 Reflection.findMethod(CenteringRing.class, "setOuterRadius", double.class),
418 Reflection.findMethod(CenteringRing.class, "setOuterRadiusAutomatic", boolean.class)));
422 setters.put("MassObject:packedlength", new DoubleSetter(
423 Reflection.findMethod(MassObject.class, "setLength", double.class)));
424 setters.put("MassObject:packedradius", new DoubleSetter(
425 Reflection.findMethod(MassObject.class, "setRadius", double.class)));
426 setters.put("MassObject:radialposition", new DoubleSetter(
427 Reflection.findMethod(MassObject.class, "setRadialPosition", double.class)));
428 setters.put("MassObject:radialdirection", new DoubleSetter(
429 Reflection.findMethod(MassObject.class, "setRadialDirection", double.class),
433 setters.put("MassComponent:mass", new DoubleSetter(
434 Reflection.findMethod(MassComponent.class, "setComponentMass", double.class)));
437 setters.put("ShockCord:cordlength", new DoubleSetter(
438 Reflection.findMethod(ShockCord.class, "setCordLength", double.class)));
439 setters.put("ShockCord:material", new MaterialSetter(
440 Reflection.findMethod(ShockCord.class, "setMaterial", Material.class),
441 Material.Type.LINE));
444 setters.put("RecoveryDevice:cd", new DoubleSetter(
445 Reflection.findMethod(RecoveryDevice.class, "setCD", double.class),
447 Reflection.findMethod(RecoveryDevice.class, "setCDAutomatic", boolean.class)));
448 setters.put("RecoveryDevice:deployevent", new EnumSetter<RecoveryDevice.DeployEvent>(
449 Reflection.findMethod(RecoveryDevice.class, "setDeployEvent", RecoveryDevice.DeployEvent.class),
450 RecoveryDevice.DeployEvent.class));
451 setters.put("RecoveryDevice:deployaltitude", new DoubleSetter(
452 Reflection.findMethod(RecoveryDevice.class, "setDeployAltitude", double.class)));
453 setters.put("RecoveryDevice:deploydelay", new DoubleSetter(
454 Reflection.findMethod(RecoveryDevice.class, "setDeployDelay", double.class)));
455 setters.put("RecoveryDevice:material", new MaterialSetter(
456 Reflection.findMethod(RecoveryDevice.class, "setMaterial", Material.class),
457 Material.Type.SURFACE));
460 setters.put("Parachute:diameter", new DoubleSetter(
461 Reflection.findMethod(Parachute.class, "setDiameter", double.class)));
462 setters.put("Parachute:linecount", new IntSetter(
463 Reflection.findMethod(Parachute.class, "setLineCount", int.class)));
464 setters.put("Parachute:linelength", new DoubleSetter(
465 Reflection.findMethod(Parachute.class, "setLineLength", double.class)));
466 setters.put("Parachute:linematerial", new MaterialSetter(
467 Reflection.findMethod(Parachute.class, "setLineMaterial", Material.class),
468 Material.Type.LINE));
471 setters.put("Streamer:striplength", new DoubleSetter(
472 Reflection.findMethod(Streamer.class, "setStripLength", double.class)));
473 setters.put("Streamer:stripwidth", new DoubleSetter(
474 Reflection.findMethod(Streamer.class, "setStripWidth", double.class)));
477 // <motorconfiguration> handled by separate handler
478 setters.put("Rocket:referencetype", new EnumSetter<ReferenceType>(
479 Reflection.findMethod(Rocket.class, "setReferenceType", ReferenceType.class),
480 ReferenceType.class));
481 setters.put("Rocket:customreference", new DoubleSetter(
482 Reflection.findMethod(Rocket.class, "setCustomReferenceLength", double.class)));
483 setters.put("Rocket:designer", new StringSetter(
484 Reflection.findMethod(Rocket.class, "setDesigner", String.class)));
485 setters.put("Rocket:revision", new StringSetter(
486 Reflection.findMethod(Rocket.class, "setRevision", String.class)));
489 setters.put("Stage:separationevent", new EnumSetter<Stage.SeparationEvent>(
490 Reflection.findMethod(Stage.class, "setSeparationEvent", Stage.SeparationEvent.class),
491 Stage.SeparationEvent.class));
492 setters.put("Stage:separationdelay", new DoubleSetter(
493 Reflection.findMethod(Stage.class, "setSeparationDelay", double.class)));
499 * Search for a enum value that has the corresponding name as an XML value. The current
500 * conversion from enum name to XML value is to lowercase the name and strip out all
501 * underscore characters. This method returns a match to these criteria, or <code>null</code>
502 * if no such enum exists.
504 * @param <T> then enum type.
505 * @param name the XML value, null ok.
506 * @param enumClass the class of the enum.
507 * @return the found enum value, or <code>null</code>.
509 public static <T extends Enum<T>> Enum<T> findEnum(String name,
510 Class<? extends Enum<T>> enumClass) {
515 for (Enum<T> e : enumClass.getEnumConstants()) {
516 if (e.name().toLowerCase(Locale.ENGLISH).replace("_", "").equals(name)) {
525 * Convert a string to a double including formatting specifications of the OpenRocket
526 * file format. This accepts all formatting that is valid for
527 * <code>Double.parseDouble(s)</code> and a few others as well ("Inf", "-Inf").
529 * @param s the string to parse.
530 * @return the numerical value.
531 * @throws NumberFormatException the the string cannot be parsed.
533 public static double stringToDouble(String s) throws NumberFormatException {
535 throw new NumberFormatException("null string");
536 if (s.equalsIgnoreCase("NaN"))
538 if (s.equalsIgnoreCase("Inf"))
539 return Double.POSITIVE_INFINITY;
540 if (s.equalsIgnoreCase("-Inf"))
541 return Double.NEGATIVE_INFINITY;
542 return Double.parseDouble(s);
551 * The starting point of the handlers. Accepts a single <openrocket> element and hands
552 * the contents to be read by a OpenRocketContentsHandler.
554 class OpenRocketHandler extends AbstractElementHandler {
555 private final DocumentLoadingContext context;
556 private OpenRocketContentHandler handler = null;
558 public OpenRocketHandler(DocumentLoadingContext context) {
559 this.context = context;
563 * Return the OpenRocketDocument read from the file, or <code>null</code> if a document
564 * has not been read yet.
566 * @return the document read, or null.
568 public OpenRocketDocument getDocument() {
569 return handler.getDocument();
573 public ElementHandler openElement(String element, HashMap<String, String> attributes,
574 WarningSet warnings) {
576 // Check for unknown elements
577 if (!element.equals("openrocket")) {
578 warnings.add(Warning.fromString("Unknown element " + element + ", ignoring."));
582 // Check for first call
583 if (handler != null) {
584 warnings.add(Warning.fromString("Multiple document elements found, ignoring later "
589 // Check version number
590 String version = null;
591 String creator = attributes.remove("creator");
592 String docVersion = attributes.remove("version");
593 for (String v : DocumentConfig.SUPPORTED_VERSIONS) {
594 if (v.equals(docVersion)) {
599 if (version == null) {
600 String str = "Unsupported document version";
601 if (docVersion != null)
602 str += " " + docVersion;
603 if (creator != null && !creator.trim().equals(""))
604 str += " (written using '" + creator.trim() + "')";
605 str += ", attempting to read file anyway.";
609 context.setFileVersion(parseVersion(docVersion));
611 handler = new OpenRocketContentHandler(context);
616 private int parseVersion(String docVersion) {
617 if (docVersion == null)
620 Matcher m = Pattern.compile("^([0-9]+)\\.([0-9]+)$").matcher(docVersion);
622 int major = Integer.parseInt(m.group(1));
623 int minor = Integer.parseInt(m.group(2));
624 return major * DocumentConfig.FILE_VERSION_DIVISOR + minor;
631 public void closeElement(String element, HashMap<String, String> attributes,
632 String content, WarningSet warnings) throws SAXException {
633 attributes.remove("version");
634 attributes.remove("creator");
635 super.closeElement(element, attributes, content, warnings);
643 * Handles the content of the <openrocket> tag.
645 class OpenRocketContentHandler extends AbstractElementHandler {
646 private final DocumentLoadingContext context;
647 private final OpenRocketDocument doc;
648 private final Rocket rocket;
650 private boolean rocketDefined = false;
651 private boolean simulationsDefined = false;
653 public OpenRocketContentHandler(DocumentLoadingContext context) {
654 this.context = context;
655 this.rocket = new Rocket();
656 this.doc = new OpenRocketDocument(rocket);
660 public OpenRocketDocument getDocument() {
667 public ElementHandler openElement(String element, HashMap<String, String> attributes,
668 WarningSet warnings) {
670 if (element.equals("rocket")) {
673 .fromString("Multiple rocket designs within one document, "
674 + "ignoring later ones."));
677 rocketDefined = true;
678 return new ComponentParameterHandler(rocket, context);
681 if (element.equals("simulations")) {
682 if (simulationsDefined) {
684 .fromString("Multiple simulation definitions within one document, "
685 + "ignoring later ones."));
688 simulationsDefined = true;
689 return new SimulationsHandler(doc, context);
692 warnings.add(Warning.fromString("Unknown element " + element + ", ignoring."));
702 * A handler that creates components from the corresponding elements. The control of the
703 * contents is passed on to ComponentParameterHandler.
705 class ComponentHandler extends AbstractElementHandler {
706 private final DocumentLoadingContext context;
707 private final RocketComponent parent;
709 public ComponentHandler(RocketComponent parent, DocumentLoadingContext context) {
710 this.parent = parent;
711 this.context = context;
715 public ElementHandler openElement(String element, HashMap<String, String> attributes,
716 WarningSet warnings) {
718 // Attempt to construct new component
719 Constructor<? extends RocketComponent> constructor = DocumentConfig.constructors
721 if (constructor == null) {
722 warnings.add(Warning.fromString("Unknown element " + element + ", ignoring."));
728 c = constructor.newInstance();
729 } catch (InstantiationException e) {
730 throw new BugException("Error constructing component.", e);
731 } catch (IllegalAccessException e) {
732 throw new BugException("Error constructing component.", e);
733 } catch (InvocationTargetException e) {
734 throw Reflection.handleWrappedException(e);
739 return new ComponentParameterHandler(c, context);
745 * A handler that populates the parameters of a previously constructed rocket component.
746 * This uses the setters, or delegates the handling to another handler for specific
749 class ComponentParameterHandler extends AbstractElementHandler {
750 private final DocumentLoadingContext context;
751 private final RocketComponent component;
753 public ComponentParameterHandler(RocketComponent c, DocumentLoadingContext context) {
755 this.context = context;
759 public ElementHandler openElement(String element, HashMap<String, String> attributes,
760 WarningSet warnings) {
762 // Check for specific elements that contain other elements
763 if (element.equals("subcomponents")) {
764 return new ComponentHandler(component, context);
766 if (element.equals("motormount")) {
767 if (!(component instanceof MotorMount)) {
768 warnings.add(Warning.fromString("Illegal component defined as motor mount."));
771 return new MotorMountHandler((MotorMount) component, context);
773 if (element.equals("finpoints")) {
774 if (!(component instanceof FreeformFinSet)) {
775 warnings.add(Warning.fromString("Illegal component defined for fin points."));
778 return new FinSetPointHandler((FreeformFinSet) component, context);
780 if (element.equals("motorconfiguration")) {
781 if (!(component instanceof Rocket)) {
782 warnings.add(Warning.fromString("Illegal component defined for motor configuration."));
785 return new MotorConfigurationHandler((Rocket) component, context);
789 return PlainTextHandler.INSTANCE;
793 public void closeElement(String element, HashMap<String, String> attributes,
794 String content, WarningSet warnings) {
796 if (element.equals("subcomponents") || element.equals("motormount") ||
797 element.equals("finpoints") || element.equals("motorconfiguration")) {
801 // Search for the correct setter class
804 for (c = component.getClass(); c != null; c = c.getSuperclass()) {
805 String setterKey = c.getSimpleName() + ":" + element;
806 Setter s = DocumentConfig.setters.get(setterKey);
809 s.set(component, content, attributes, warnings);
812 if (DocumentConfig.setters.containsKey(setterKey)) {
813 // Key exists but is null -> invalid parameter
819 warnings.add(Warning.fromString("Unknown parameter type '" + element + "' for "
820 + component.getComponentName() + ", ignoring."));
827 * A handler that reads the <point> specifications within the freeformfinset's
828 * <finpoints> elements.
830 class FinSetPointHandler extends AbstractElementHandler {
831 @SuppressWarnings("unused")
832 private final DocumentLoadingContext context;
833 private final FreeformFinSet finset;
834 private final ArrayList<Coordinate> coordinates = new ArrayList<Coordinate>();
836 public FinSetPointHandler(FreeformFinSet finset, DocumentLoadingContext context) {
837 this.finset = finset;
838 this.context = context;
842 public ElementHandler openElement(String element, HashMap<String, String> attributes,
843 WarningSet warnings) {
844 return PlainTextHandler.INSTANCE;
849 public void closeElement(String element, HashMap<String, String> attributes,
850 String content, WarningSet warnings) throws SAXException {
852 String strx = attributes.remove("x");
853 String stry = attributes.remove("y");
854 if (strx == null || stry == null) {
855 warnings.add(Warning.fromString("Illegal fin points specification, ignoring."));
859 double x = Double.parseDouble(strx);
860 double y = Double.parseDouble(stry);
861 coordinates.add(new Coordinate(x, y));
862 } catch (NumberFormatException e) {
863 warnings.add(Warning.fromString("Illegal fin points specification, ignoring."));
867 super.closeElement(element, attributes, content, warnings);
871 public void endHandler(String element, HashMap<String, String> attributes,
872 String content, WarningSet warnings) {
874 finset.setPoints(coordinates.toArray(new Coordinate[0]));
875 } catch (IllegalFinPointException e) {
876 warnings.add(Warning.fromString("Freeform fin set point definitions illegal, ignoring."));
882 class MotorMountHandler extends AbstractElementHandler {
883 private final DocumentLoadingContext context;
884 private final MotorMount mount;
885 private MotorHandler motorHandler;
887 public MotorMountHandler(MotorMount mount, DocumentLoadingContext context) {
889 this.context = context;
890 mount.setMotorMount(true);
894 public ElementHandler openElement(String element, HashMap<String, String> attributes,
895 WarningSet warnings) {
897 if (element.equals("motor")) {
898 motorHandler = new MotorHandler(context);
902 if (element.equals("ignitionevent") ||
903 element.equals("ignitiondelay") ||
904 element.equals("overhang")) {
905 return PlainTextHandler.INSTANCE;
908 warnings.add(Warning.fromString("Unknown element '" + element + "' encountered, ignoring."));
915 public void closeElement(String element, HashMap<String, String> attributes,
916 String content, WarningSet warnings) throws SAXException {
918 if (element.equals("motor")) {
919 String id = attributes.get("configid");
920 if (id == null || id.equals("")) {
921 warnings.add(Warning.fromString("Illegal motor specification, ignoring."));
925 Motor motor = motorHandler.getMotor(warnings);
926 mount.setMotor(id, motor);
927 mount.setMotorDelay(id, motorHandler.getDelay(warnings));
931 if (element.equals("ignitionevent")) {
932 MotorMount.IgnitionEvent event = null;
933 for (MotorMount.IgnitionEvent e : MotorMount.IgnitionEvent.values()) {
934 if (e.name().toLowerCase(Locale.ENGLISH).replaceAll("_", "").equals(content)) {
940 warnings.add(Warning.fromString("Unknown ignition event type '" + content + "', ignoring."));
943 mount.setIgnitionEvent(event);
947 if (element.equals("ignitiondelay")) {
950 d = Double.parseDouble(content);
951 } catch (NumberFormatException nfe) {
952 warnings.add(Warning.fromString("Illegal ignition delay specified, ignoring."));
955 mount.setIgnitionDelay(d);
959 if (element.equals("overhang")) {
962 d = Double.parseDouble(content);
963 } catch (NumberFormatException nfe) {
964 warnings.add(Warning.fromString("Illegal overhang specified, ignoring."));
967 mount.setMotorOverhang(d);
971 super.closeElement(element, attributes, content, warnings);
978 class MotorConfigurationHandler extends AbstractElementHandler {
979 @SuppressWarnings("unused")
980 private final DocumentLoadingContext context;
981 private final Rocket rocket;
982 private String name = null;
983 private boolean inNameElement = false;
985 public MotorConfigurationHandler(Rocket rocket, DocumentLoadingContext context) {
986 this.rocket = rocket;
987 this.context = context;
991 public ElementHandler openElement(String element, HashMap<String, String> attributes,
992 WarningSet warnings) {
994 if (inNameElement || !element.equals("name")) {
995 warnings.add(Warning.FILE_INVALID_PARAMETER);
998 inNameElement = true;
1000 return PlainTextHandler.INSTANCE;
1004 public void closeElement(String element, HashMap<String, String> attributes,
1005 String content, WarningSet warnings) {
1010 public void endHandler(String element, HashMap<String, String> attributes,
1011 String content, WarningSet warnings) throws SAXException {
1013 String configid = attributes.remove("configid");
1014 if (configid == null || configid.equals("")) {
1015 warnings.add(Warning.FILE_INVALID_PARAMETER);
1019 if (!rocket.addMotorConfigurationID(configid)) {
1020 warnings.add("Duplicate motor configuration ID used.");
1024 if (name != null && name.trim().length() > 0) {
1025 rocket.setMotorConfigurationName(configid, name);
1028 if ("true".equals(attributes.remove("default"))) {
1029 rocket.getDefaultConfiguration().setMotorConfigurationID(configid);
1032 super.closeElement(element, attributes, content, warnings);
1037 class MotorHandler extends AbstractElementHandler {
1038 /** File version where latest digest format was introduced */
1039 private static final int MOTOR_DIGEST_VERSION = 104;
1041 private final DocumentLoadingContext context;
1042 private Motor.Type type = null;
1043 private String manufacturer = null;
1044 private String designation = null;
1045 private String digest = null;
1046 private double diameter = Double.NaN;
1047 private double length = Double.NaN;
1048 private double delay = Double.NaN;
1050 public MotorHandler(DocumentLoadingContext context) {
1051 this.context = context;
1056 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1057 WarningSet warnings) {
1058 return PlainTextHandler.INSTANCE;
1063 * Return the motor to use, or null.
1065 public Motor getMotor(WarningSet warnings) {
1066 return context.getMotorFinder().findMotor(type, manufacturer, designation, diameter, length, digest, warnings);
1070 * Return the delay to use for the motor.
1072 public double getDelay(WarningSet warnings) {
1073 if (Double.isNaN(delay)) {
1074 warnings.add(Warning.fromString("Motor delay not specified, assuming no ejection charge."));
1075 return Motor.PLUGGED;
1082 public void closeElement(String element, HashMap<String, String> attributes,
1083 String content, WarningSet warnings) throws SAXException {
1085 content = content.trim();
1087 if (element.equals("type")) {
1091 for (Motor.Type t : Motor.Type.values()) {
1092 if (t.name().toLowerCase(Locale.ENGLISH).equals(content.trim())) {
1098 warnings.add(Warning.fromString("Unknown motor type '" + content + "', ignoring."));
1101 } else if (element.equals("manufacturer")) {
1104 manufacturer = content.trim();
1106 } else if (element.equals("designation")) {
1109 designation = content.trim();
1111 } else if (element.equals("digest")) {
1113 // Digest is used only for file versions saved using the same digest algorithm
1114 if (context.getFileVersion() >= MOTOR_DIGEST_VERSION) {
1115 digest = content.trim();
1118 } else if (element.equals("diameter")) {
1121 diameter = Double.NaN;
1123 diameter = Double.parseDouble(content.trim());
1124 } catch (NumberFormatException e) {
1127 if (Double.isNaN(diameter)) {
1128 warnings.add(Warning.fromString("Illegal motor diameter specified, ignoring."));
1131 } else if (element.equals("length")) {
1134 length = Double.NaN;
1136 length = Double.parseDouble(content.trim());
1137 } catch (NumberFormatException ignore) {
1140 if (Double.isNaN(length)) {
1141 warnings.add(Warning.fromString("Illegal motor diameter specified, ignoring."));
1144 } else if (element.equals("delay")) {
1148 if (content.equals("none")) {
1149 delay = Motor.PLUGGED;
1152 delay = Double.parseDouble(content.trim());
1153 } catch (NumberFormatException ignore) {
1156 if (Double.isNaN(delay)) {
1157 warnings.add(Warning.fromString("Illegal motor delay specified, ignoring."));
1163 super.closeElement(element, attributes, content, warnings);
1171 class SimulationsHandler extends AbstractElementHandler {
1172 private final DocumentLoadingContext context;
1173 private final OpenRocketDocument doc;
1174 private SingleSimulationHandler handler;
1176 public SimulationsHandler(OpenRocketDocument doc, DocumentLoadingContext context) {
1178 this.context = context;
1182 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1183 WarningSet warnings) {
1185 if (!element.equals("simulation")) {
1186 warnings.add("Unknown element '" + element + "', ignoring.");
1190 handler = new SingleSimulationHandler(doc, context);
1195 public void closeElement(String element, HashMap<String, String> attributes,
1196 String content, WarningSet warnings) throws SAXException {
1197 attributes.remove("status");
1198 super.closeElement(element, attributes, content, warnings);
1204 class SingleSimulationHandler extends AbstractElementHandler {
1206 private final DocumentLoadingContext context;
1208 private final OpenRocketDocument doc;
1210 private String name;
1212 private SimulationConditionsHandler conditionHandler;
1213 private FlightDataHandler dataHandler;
1214 private CustomExpressionsHandler customExpressionsHandler;
1216 private ArrayList<CustomExpression> customExpressions = new ArrayList<CustomExpression>();
1217 private final List<String> listeners = new ArrayList<String>();
1219 public SingleSimulationHandler(OpenRocketDocument doc, DocumentLoadingContext context) {
1221 this.context = context;
1224 public void setCustomExpressions(ArrayList<CustomExpression> expressions){
1225 this.customExpressions = expressions;
1228 public ArrayList<CustomExpression> getCustomExpressions(){
1229 return customExpressions;
1233 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1234 WarningSet warnings) {
1236 if (element.equals("name") || element.equals("simulator") ||
1237 element.equals("calculator") || element.equals("listener")) {
1238 return PlainTextHandler.INSTANCE;
1239 } else if (element.equals("customexpressions")) {
1240 customExpressionsHandler = new CustomExpressionsHandler(this, context);
1241 return customExpressionsHandler;
1242 } else if (element.equals("conditions")) {
1243 conditionHandler = new SimulationConditionsHandler(doc.getRocket(), context);
1244 return conditionHandler;
1245 } else if (element.equals("flightdata")) {
1246 dataHandler = new FlightDataHandler(this, context);
1249 warnings.add("Unknown element '" + element + "', ignoring.");
1255 public void closeElement(String element, HashMap<String, String> attributes,
1256 String content, WarningSet warnings) {
1258 if (element.equals("name")) {
1260 } else if (element.equals("simulator")) {
1261 if (!content.trim().equals("RK4Simulator")) {
1262 warnings.add("Unknown simulator '" + content.trim() + "' specified, ignoring.");
1264 } else if (element.equals("calculator")) {
1265 if (!content.trim().equals("BarrowmanCalculator")) {
1266 warnings.add("Unknown calculator '" + content.trim() + "' specified, ignoring.");
1268 } else if (element.equals("listener") && content.trim().length() > 0) {
1269 listeners.add(content.trim());
1275 public void endHandler(String element, HashMap<String, String> attributes,
1276 String content, WarningSet warnings) {
1278 String s = attributes.get("status");
1279 Simulation.Status status = (Status) DocumentConfig.findEnum(s, Simulation.Status.class);
1280 if (status == null) {
1281 warnings.add("Simulation status unknown, assuming outdated.");
1282 status = Simulation.Status.OUTDATED;
1285 SimulationOptions conditions;
1286 if (conditionHandler != null) {
1287 conditions = conditionHandler.getConditions();
1289 warnings.add("Simulation conditions not defined, using defaults.");
1290 conditions = new SimulationOptions(doc.getRocket());
1294 name = "Simulation";
1297 if (dataHandler == null)
1300 data = dataHandler.getFlightData();
1302 Simulation simulation = new Simulation(doc.getRocket(), status, name,
1303 conditions, listeners, data);
1305 // Note : arraylist implementation in simulation different from standard one
1306 for (CustomExpression exp : customExpressions){
1307 exp.setSimulation(simulation);
1309 simulation.addCustomExpression(exp);
1312 doc.addSimulation(simulation);
1316 class CustomExpressionsHandler extends AbstractElementHandler {
1317 private final DocumentLoadingContext context;
1318 private final SingleSimulationHandler simHandler;
1319 public CustomExpression currentExpression = new CustomExpression();
1320 private final ArrayList<CustomExpression> customExpressions = new ArrayList<CustomExpression>();
1323 public CustomExpressionsHandler(SingleSimulationHandler simHandler, DocumentLoadingContext context) {
1324 this.context = context;
1325 this.simHandler = simHandler;
1329 public ElementHandler openElement(String element,
1330 HashMap<String, String> attributes, WarningSet warnings)
1331 throws SAXException {
1333 if (element.equals("expression")){
1334 currentExpression = new CustomExpression();
1341 public void closeElement(String element, HashMap<String, String> attributes,
1342 String content, WarningSet warnings) {
1344 if (element.equals("expression"))
1345 customExpressions.add(currentExpression);
1347 if (element.equals("name"))
1348 currentExpression.setName(content);
1350 else if (element.equals("symbol"))
1351 currentExpression.setSymbol(content);
1353 else if (element.equals("unit"))
1354 currentExpression.setUnit(content);
1356 else if (element.equals("expressionstring"))
1357 currentExpression.setExpression(content);
1362 public void endHandler(String element, HashMap<String, String> attributes,
1363 String content, WarningSet warnings) {
1364 simHandler.setCustomExpressions(customExpressions);
1368 class SimulationConditionsHandler extends AbstractElementHandler {
1369 private final DocumentLoadingContext context;
1370 private SimulationOptions conditions;
1371 private AtmosphereHandler atmosphereHandler;
1373 public SimulationConditionsHandler(Rocket rocket, DocumentLoadingContext context) {
1374 this.context = context;
1375 conditions = new SimulationOptions(rocket);
1376 // Set up default loading settings (which may differ from the new defaults)
1377 conditions.setGeodeticComputation(GeodeticComputationStrategy.FLAT);
1380 public SimulationOptions getConditions() {
1385 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1386 WarningSet warnings) {
1387 if (element.equals("atmosphere")) {
1388 atmosphereHandler = new AtmosphereHandler(attributes.get("model"), context);
1389 return atmosphereHandler;
1391 return PlainTextHandler.INSTANCE;
1395 public void closeElement(String element, HashMap<String, String> attributes,
1396 String content, WarningSet warnings) {
1398 double d = Double.NaN;
1400 d = Double.parseDouble(content);
1401 } catch (NumberFormatException ignore) {
1405 if (element.equals("configid")) {
1406 if (content.equals("")) {
1407 conditions.setMotorConfigurationID(null);
1409 conditions.setMotorConfigurationID(content);
1411 } else if (element.equals("launchrodlength")) {
1412 if (Double.isNaN(d)) {
1413 warnings.add("Illegal launch rod length defined, ignoring.");
1415 conditions.setLaunchRodLength(d);
1417 } else if (element.equals("launchrodangle")) {
1418 if (Double.isNaN(d)) {
1419 warnings.add("Illegal launch rod angle defined, ignoring.");
1421 conditions.setLaunchRodAngle(d * Math.PI / 180);
1423 } else if (element.equals("launchroddirection")) {
1424 if (Double.isNaN(d)) {
1425 warnings.add("Illegal launch rod direction defined, ignoring.");
1427 conditions.setLaunchRodDirection(d * Math.PI / 180);
1429 } else if (element.equals("windaverage")) {
1430 if (Double.isNaN(d)) {
1431 warnings.add("Illegal average windspeed defined, ignoring.");
1433 conditions.setWindSpeedAverage(d);
1435 } else if (element.equals("windturbulence")) {
1436 if (Double.isNaN(d)) {
1437 warnings.add("Illegal wind turbulence intensity defined, ignoring.");
1439 conditions.setWindTurbulenceIntensity(d);
1441 } else if (element.equals("launchaltitude")) {
1442 if (Double.isNaN(d)) {
1443 warnings.add("Illegal launch altitude defined, ignoring.");
1445 conditions.setLaunchAltitude(d);
1447 } else if (element.equals("launchlatitude")) {
1448 if (Double.isNaN(d)) {
1449 warnings.add("Illegal launch latitude defined, ignoring.");
1451 conditions.setLaunchLatitude(d);
1453 } else if (element.equals("launchlongitude")) {
1454 if (Double.isNaN(d)) {
1455 warnings.add("Illegal launch longitude.");
1457 conditions.setLaunchLongitude(d);
1459 } else if (element.equals("geodeticmethod")) {
1460 GeodeticComputationStrategy gcs =
1461 (GeodeticComputationStrategy) DocumentConfig.findEnum(content, GeodeticComputationStrategy.class);
1463 conditions.setGeodeticComputation(gcs);
1465 warnings.add("Unknown geodetic computation method '" + content + "'");
1467 } else if (element.equals("atmosphere")) {
1468 atmosphereHandler.storeSettings(conditions, warnings);
1469 } else if (element.equals("timestep")) {
1470 if (Double.isNaN(d)) {
1471 warnings.add("Illegal time step defined, ignoring.");
1473 conditions.setTimeStep(d);
1480 class AtmosphereHandler extends AbstractElementHandler {
1481 @SuppressWarnings("unused")
1482 private final DocumentLoadingContext context;
1483 private final String model;
1484 private double temperature = Double.NaN;
1485 private double pressure = Double.NaN;
1487 public AtmosphereHandler(String model, DocumentLoadingContext context) {
1489 this.context = context;
1493 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1494 WarningSet warnings) {
1495 return PlainTextHandler.INSTANCE;
1499 public void closeElement(String element, HashMap<String, String> attributes,
1500 String content, WarningSet warnings) throws SAXException {
1502 double d = Double.NaN;
1504 d = Double.parseDouble(content);
1505 } catch (NumberFormatException ignore) {
1508 if (element.equals("basetemperature")) {
1509 if (Double.isNaN(d)) {
1510 warnings.add("Illegal base temperature specified, ignoring.");
1513 } else if (element.equals("basepressure")) {
1514 if (Double.isNaN(d)) {
1515 warnings.add("Illegal base pressure specified, ignoring.");
1519 super.closeElement(element, attributes, content, warnings);
1524 public void storeSettings(SimulationOptions cond, WarningSet warnings) {
1525 if (!Double.isNaN(pressure)) {
1526 cond.setLaunchPressure(pressure);
1528 if (!Double.isNaN(temperature)) {
1529 cond.setLaunchTemperature(temperature);
1532 if ("isa".equals(model)) {
1533 cond.setISAAtmosphere(true);
1534 } else if ("extendedisa".equals(model)) {
1535 cond.setISAAtmosphere(false);
1537 cond.setISAAtmosphere(true);
1538 warnings.add("Unknown atmospheric model, using ISA.");
1545 class FlightDataHandler extends AbstractElementHandler {
1546 private final DocumentLoadingContext context;
1548 private FlightDataBranchHandler dataHandler;
1549 private WarningSet warningSet = new WarningSet();
1550 private List<FlightDataBranch> branches = new ArrayList<FlightDataBranch>();
1552 private SingleSimulationHandler simHandler;
1553 private FlightData data;
1556 public FlightDataHandler(SingleSimulationHandler simHandler, DocumentLoadingContext context) {
1557 this.context = context;
1558 this.simHandler = simHandler;
1561 public FlightData getFlightData() {
1566 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1567 WarningSet warnings) {
1569 if (element.equals("warning")) {
1570 return PlainTextHandler.INSTANCE;
1572 if (element.equals("databranch")) {
1573 if (attributes.get("name") == null || attributes.get("types") == null) {
1574 warnings.add("Illegal flight data definition, ignoring.");
1577 dataHandler = new FlightDataBranchHandler( attributes.get("name"),
1578 attributes.get("types"),
1579 simHandler, context);
1583 warnings.add("Unknown element '" + element + "' encountered, ignoring.");
1589 public void closeElement(String element, HashMap<String, String> attributes,
1590 String content, WarningSet warnings) {
1592 if (element.equals("databranch")) {
1593 FlightDataBranch branch = dataHandler.getBranch();
1594 if (branch.getLength() > 0) {
1595 branches.add(branch);
1597 } else if (element.equals("warning")) {
1598 warningSet.add(Warning.fromString(content));
1604 public void endHandler(String element, HashMap<String, String> attributes,
1605 String content, WarningSet warnings) {
1607 if (branches.size() > 0) {
1608 data = new FlightData(branches.toArray(new FlightDataBranch[0]));
1610 double maxAltitude = Double.NaN;
1611 double maxVelocity = Double.NaN;
1612 double maxAcceleration = Double.NaN;
1613 double maxMach = Double.NaN;
1614 double timeToApogee = Double.NaN;
1615 double flightTime = Double.NaN;
1616 double groundHitVelocity = Double.NaN;
1617 double launchRodVelocity = Double.NaN;
1618 double deploymentVelocity = Double.NaN;
1621 maxAltitude = DocumentConfig.stringToDouble(attributes.get("maxaltitude"));
1622 } catch (NumberFormatException ignore) {
1625 maxVelocity = DocumentConfig.stringToDouble(attributes.get("maxvelocity"));
1626 } catch (NumberFormatException ignore) {
1629 maxAcceleration = DocumentConfig.stringToDouble(attributes.get("maxacceleration"));
1630 } catch (NumberFormatException ignore) {
1633 maxMach = DocumentConfig.stringToDouble(attributes.get("maxmach"));
1634 } catch (NumberFormatException ignore) {
1637 timeToApogee = DocumentConfig.stringToDouble(attributes.get("timetoapogee"));
1638 } catch (NumberFormatException ignore) {
1641 flightTime = DocumentConfig.stringToDouble(attributes.get("flighttime"));
1642 } catch (NumberFormatException ignore) {
1646 DocumentConfig.stringToDouble(attributes.get("groundhitvelocity"));
1647 } catch (NumberFormatException ignore) {
1650 launchRodVelocity = DocumentConfig.stringToDouble(attributes.get("launchrodvelocity"));
1651 } catch (NumberFormatException ignore) {
1654 deploymentVelocity = DocumentConfig.stringToDouble(attributes.get("deploymentvelocity"));
1655 } catch (NumberFormatException ignore) {
1658 data = new FlightData(maxAltitude, maxVelocity, maxAcceleration, maxMach,
1659 timeToApogee, flightTime, groundHitVelocity, launchRodVelocity, deploymentVelocity);
1662 data.getWarningSet().addAll(warningSet);
1670 class FlightDataBranchHandler extends AbstractElementHandler {
1671 @SuppressWarnings("unused")
1672 private final DocumentLoadingContext context;
1673 private final FlightDataType[] types;
1674 private final FlightDataBranch branch;
1676 private static final LogHelper log = Application.getLogger();
1677 private final SingleSimulationHandler simHandler;
1679 public FlightDataBranchHandler(String name, String typeList, SingleSimulationHandler simHandler, DocumentLoadingContext context) {
1680 this.simHandler = simHandler;
1681 this.context = context;
1682 String[] split = typeList.split(",");
1683 types = new FlightDataType[split.length];
1684 for (int i = 0; i < split.length; i++) {
1685 String typeName = split[i];
1686 FlightDataType matching = findFlightDataType(typeName);
1687 types[i] = matching;
1688 //types[i] = FlightDataType.getType(typeName, matching.getSymbol(), matching.getUnitGroup());
1691 // TODO: LOW: May throw an IllegalArgumentException
1692 branch = new FlightDataBranch(name, types);
1695 // Find the full flight data type given name only
1696 // Note: this way of doing it requires that custom expressions always come before flight data in the file,
1697 // not the nicest but this is always the case anyway.
1698 private FlightDataType findFlightDataType(String name){
1700 // Look in built in types
1701 for (FlightDataType t : FlightDataType.ALL_TYPES){
1702 if (t.getName().equals(name) ){
1707 // Look in custom expressions, meanwhile set priority based on order in file
1708 int totalExpressions = simHandler.getCustomExpressions().size();
1709 for (int i=0; i<totalExpressions; i++){
1710 CustomExpression exp = simHandler.getCustomExpressions().get(i);
1711 if (exp.getName().equals(name) ){
1712 FlightDataType t = exp.getType();
1713 t.setPriority(-1*(totalExpressions-i));
1714 return exp.getType();
1718 log.warn("Could not find the flight data type '"+name+"' used in the XML file. Substituted type with unknown symbol and units.");
1719 return FlightDataType.getType(name, "Unknown", UnitGroup.UNITS_NONE);
1722 public FlightDataBranch getBranch() {
1728 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1729 WarningSet warnings) {
1731 if (element.equals("datapoint"))
1732 return PlainTextHandler.INSTANCE;
1733 if (element.equals("event"))
1734 return PlainTextHandler.INSTANCE;
1736 warnings.add("Unknown element '" + element + "' encountered, ignoring.");
1742 public void closeElement(String element, HashMap<String, String> attributes,
1743 String content, WarningSet warnings) {
1745 if (element.equals("event")) {
1747 FlightEvent.Type type;
1750 time = DocumentConfig.stringToDouble(attributes.get("time"));
1751 } catch (NumberFormatException e) {
1752 warnings.add("Illegal event specification, ignoring.");
1756 type = (Type) DocumentConfig.findEnum(attributes.get("type"), FlightEvent.Type.class);
1758 warnings.add("Illegal event specification, ignoring.");
1762 branch.addEvent(new FlightEvent(type, time));
1766 if (!element.equals("datapoint")) {
1767 warnings.add("Unknown element '" + element + "' encountered, ignoring.");
1771 // element == "datapoint"
1774 // Check line format
1775 String[] split = content.split(",");
1776 if (split.length != types.length) {
1777 warnings.add("Data point did not contain correct amount of values, ignoring point.");
1781 // Parse the doubles
1782 double[] values = new double[split.length];
1783 for (int i = 0; i < values.length; i++) {
1785 values[i] = DocumentConfig.stringToDouble(split[i]);
1786 } catch (NumberFormatException e) {
1787 warnings.add("Data point format error, ignoring point.");
1792 // Add point to branch
1794 for (int i = 0; i < types.length; i++) {
1795 branch.setValue(types[i], values[i]);
1804 ///////////////// Setters implementation
1810 * Set the specified value to the given component.
1812 * @param component the component to which to set.
1813 * @param value the value within the element.
1814 * @param attributes attributes for the element.
1815 * @param warnings the warning set to use.
1817 public void set(RocketComponent component, String value,
1818 HashMap<String, String> attributes, WarningSet warnings);
1822 //// StringSetter - sets the value to the contained String
1823 class StringSetter implements Setter {
1824 private final Reflection.Method setMethod;
1826 public StringSetter(Reflection.Method set) {
1831 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1832 WarningSet warnings) {
1833 setMethod.invoke(c, s);
1837 //// IntSetter - set an integer value
1838 class IntSetter implements Setter {
1839 private final Reflection.Method setMethod;
1841 public IntSetter(Reflection.Method set) {
1846 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1847 WarningSet warnings) {
1849 int n = Integer.parseInt(s);
1850 setMethod.invoke(c, n);
1851 } catch (NumberFormatException e) {
1852 warnings.add(Warning.FILE_INVALID_PARAMETER);
1858 //// BooleanSetter - set a boolean value
1859 class BooleanSetter implements Setter {
1860 private final Reflection.Method setMethod;
1862 public BooleanSetter(Reflection.Method set) {
1867 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1868 WarningSet warnings) {
1871 if (s.equalsIgnoreCase("true")) {
1872 setMethod.invoke(c, true);
1873 } else if (s.equalsIgnoreCase("false")) {
1874 setMethod.invoke(c, false);
1876 warnings.add(Warning.FILE_INVALID_PARAMETER);
1883 //// DoubleSetter - sets a double value or (alternatively) if a specific string is encountered
1884 //// calls a setXXX(boolean) method.
1885 class DoubleSetter implements Setter {
1886 private final Reflection.Method setMethod;
1887 private final String specialString;
1888 private final Reflection.Method specialMethod;
1889 private final double multiplier;
1892 * Set only the double value.
1893 * @param set set method for the double value.
1895 public DoubleSetter(Reflection.Method set) {
1896 this.setMethod = set;
1897 this.specialString = null;
1898 this.specialMethod = null;
1899 this.multiplier = 1.0;
1903 * Multiply with the given multiplier and set the double value.
1904 * @param set set method for the double value.
1905 * @param mul multiplier.
1907 public DoubleSetter(Reflection.Method set, double mul) {
1908 this.setMethod = set;
1909 this.specialString = null;
1910 this.specialMethod = null;
1911 this.multiplier = mul;
1915 * Set the double value, or if the value equals the special string, use the
1916 * special setter and set it to true.
1918 * @param set double setter.
1919 * @param special special string
1920 * @param specialMethod boolean setter.
1922 public DoubleSetter(Reflection.Method set, String special,
1923 Reflection.Method specialMethod) {
1924 this.setMethod = set;
1925 this.specialString = special;
1926 this.specialMethod = specialMethod;
1927 this.multiplier = 1.0;
1932 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1933 WarningSet warnings) {
1937 // Check for special case
1938 if (specialMethod != null && s.equalsIgnoreCase(specialString)) {
1939 specialMethod.invoke(c, true);
1945 double d = Double.parseDouble(s);
1946 setMethod.invoke(c, d * multiplier);
1947 } catch (NumberFormatException e) {
1948 warnings.add(Warning.FILE_INVALID_PARAMETER);
1954 class OverrideSetter implements Setter {
1955 private final Reflection.Method setMethod;
1956 private final Reflection.Method enabledMethod;
1958 public OverrideSetter(Reflection.Method set, Reflection.Method enabledMethod) {
1959 this.setMethod = set;
1960 this.enabledMethod = enabledMethod;
1964 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1965 WarningSet warnings) {
1968 double d = Double.parseDouble(s);
1969 setMethod.invoke(c, d);
1970 enabledMethod.invoke(c, true);
1971 } catch (NumberFormatException e) {
1972 warnings.add(Warning.FILE_INVALID_PARAMETER);
1977 //// EnumSetter - sets a generic enum type
1978 class EnumSetter<T extends Enum<T>> implements Setter {
1979 private final Reflection.Method setter;
1980 private final Class<T> enumClass;
1982 public EnumSetter(Reflection.Method set, Class<T> enumClass) {
1984 this.enumClass = enumClass;
1988 public void set(RocketComponent c, String name, HashMap<String, String> attributes,
1989 WarningSet warnings) {
1991 Enum<?> setEnum = DocumentConfig.findEnum(name, enumClass);
1992 if (setEnum == null) {
1993 warnings.add(Warning.FILE_INVALID_PARAMETER);
1997 setter.invoke(c, setEnum);
2002 //// ColorSetter - sets a Color value
2003 class ColorSetter implements Setter {
2004 private final Reflection.Method setMethod;
2006 public ColorSetter(Reflection.Method set) {
2011 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
2012 WarningSet warnings) {
2014 String red = attributes.get("red");
2015 String green = attributes.get("green");
2016 String blue = attributes.get("blue");
2018 if (red == null || green == null || blue == null) {
2019 warnings.add(Warning.FILE_INVALID_PARAMETER);
2025 r = Integer.parseInt(red);
2026 g = Integer.parseInt(green);
2027 b = Integer.parseInt(blue);
2028 } catch (NumberFormatException e) {
2029 warnings.add(Warning.FILE_INVALID_PARAMETER);
2033 if (r < 0 || g < 0 || b < 0 || r > 255 || g > 255 || b > 255) {
2034 warnings.add(Warning.FILE_INVALID_PARAMETER);
2038 Color color = new Color(r, g, b);
2039 setMethod.invoke(c, color);
2041 if (!s.trim().equals("")) {
2042 warnings.add(Warning.FILE_INVALID_PARAMETER);
2047 ////ComponentPresetSetter - sets a ComponentPreset value
2048 class ComponentPresetSetter implements Setter {
2049 private final Reflection.Method setMethod;
2051 public ComponentPresetSetter(Reflection.Method set) {
2052 this.setMethod = set;
2056 public void set(RocketComponent c, String name, HashMap<String, String> attributes,
2057 WarningSet warnings) {
2058 // FIXME - probably need more data in the warning messages - like what component preset...
2059 String manufacturerName = attributes.get("manufacturer");
2060 if ( manufacturerName == null ) {
2061 warnings.add(Warning.fromString("Invalid ComponentPreset, no manufacturer specified. Ignored"));
2065 String productNo = attributes.get("partno");
2066 if ( productNo == null ) {
2067 warnings.add(Warning.fromString("Invalid ComponentPreset, no partno specified. Ignored"));
2071 String digest = attributes.get("digest");
2072 if ( digest == null ) {
2073 warnings.add(Warning.fromString("Invalid ComponentPreset, no digest specified."));
2076 String type = attributes.get("type");
2077 if ( type == null ) {
2078 warnings.add(Warning.fromString("Invalid ComponentPreset, no type specified."));
2081 List<ComponentPreset> presets = Application.getComponentPresetDao().find( manufacturerName, productNo );
2083 ComponentPreset matchingPreset = null;
2085 for( ComponentPreset preset: presets ) {
2086 if ( digest != null && preset.getDigest().equals(digest) ) {
2087 // Found one with matching digest. Take it.
2088 matchingPreset = preset;
2091 if ( type != null && preset.getType().name().equals(type) && matchingPreset != null) {
2092 // Found the first one with matching type.
2093 matchingPreset = preset;
2098 if ( matchingPreset == null ) {
2099 warnings.add(Warning.fromString("No matching ComponentPreset found"));
2103 if ( digest != null && !matchingPreset.getDigest().equals(digest) ) {
2104 warnings.add(Warning.fromString("ComponentPreset has wrong digest"));
2107 setMethod.invoke(c, matchingPreset);
2112 ////MaterialSetter - sets a Material value
2113 class MaterialSetter implements Setter {
2114 private final Reflection.Method setMethod;
2115 private final Material.Type type;
2117 public MaterialSetter(Reflection.Method set, Material.Type type) {
2118 this.setMethod = set;
2123 public void set(RocketComponent c, String name, HashMap<String, String> attributes,
2124 WarningSet warnings) {
2130 if (name.equals("")) {
2131 warnings.add(Warning.fromString("Illegal material specification, ignoring."));
2138 str = attributes.remove("density");
2140 warnings.add(Warning.fromString("Illegal material specification, ignoring."));
2144 density = Double.parseDouble(str);
2145 } catch (NumberFormatException e) {
2146 warnings.add(Warning.fromString("Illegal material specification, ignoring."));
2151 // double thickness = 0;
2152 // str = attributes.remove("thickness");
2155 // thickness = Double.parseDouble(str);
2156 // } catch (NumberFormatException e){
2157 // warnings.add(Warning.fromString("Illegal material specification, ignoring."));
2161 // Check type if specified
2162 str = attributes.remove("type");
2163 if (str != null && !type.name().toLowerCase(Locale.ENGLISH).equals(str)) {
2164 warnings.add(Warning.fromString("Illegal material type specified, ignoring."));
2168 mat = Databases.findMaterial(type, name, density, false);
2170 setMethod.invoke(c, mat);
2177 class PositionSetter implements Setter {
2180 public void set(RocketComponent c, String value, HashMap<String, String> attributes,
2181 WarningSet warnings) {
2183 RocketComponent.Position type = (Position) DocumentConfig.findEnum(attributes.get("type"),
2184 RocketComponent.Position.class);
2186 warnings.add(Warning.FILE_INVALID_PARAMETER);
2192 pos = Double.parseDouble(value);
2193 } catch (NumberFormatException e) {
2194 warnings.add(Warning.FILE_INVALID_PARAMETER);
2198 if (c instanceof FinSet) {
2199 ((FinSet) c).setRelativePosition(type);
2200 c.setPositionValue(pos);
2201 } else if (c instanceof LaunchLug) {
2202 ((LaunchLug) c).setRelativePosition(type);
2203 c.setPositionValue(pos);
2204 } else if (c instanceof InternalComponent) {
2205 ((InternalComponent) c).setRelativePosition(type);
2206 c.setPositionValue(pos);
2208 warnings.add(Warning.FILE_INVALID_PARAMETER);
2215 class FinTabPositionSetter extends DoubleSetter {
2217 public FinTabPositionSetter() {
2218 super(Reflection.findMethod(FinSet.class, "setTabShift", double.class));
2222 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
2223 WarningSet warnings) {
2225 if (!(c instanceof FinSet)) {
2226 throw new IllegalStateException("FinTabPositionSetter called for component " + c);
2229 String relative = attributes.get("relativeto");
2230 FinSet.TabRelativePosition position =
2231 (TabRelativePosition) DocumentConfig.findEnum(relative,
2232 FinSet.TabRelativePosition.class);
2234 if (position != null) {
2236 ((FinSet) c).setTabRelativePosition(position);
2239 if (relative == null) {
2240 warnings.add("Required attribute 'relativeto' not found for fin tab position.");
2242 warnings.add("Illegal attribute value '" + relative + "' encountered.");
2246 super.set(c, s, attributes, warnings);
2253 class ClusterConfigurationSetter implements Setter {
2256 public void set(RocketComponent component, String value, HashMap<String, String> attributes,
2257 WarningSet warnings) {
2259 if (!(component instanceof Clusterable)) {
2260 warnings.add("Illegal component defined as cluster.");
2264 ClusterConfiguration config = null;
2265 for (ClusterConfiguration c : ClusterConfiguration.CONFIGURATIONS) {
2266 if (c.getXMLName().equals(value)) {
2272 if (config == null) {
2273 warnings.add("Illegal cluster configuration specified.");
2277 ((Clusterable) component).setClusterConfiguration(config);