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.FlightData;
71 import net.sf.openrocket.simulation.FlightDataBranch;
72 import net.sf.openrocket.simulation.FlightDataType;
73 import net.sf.openrocket.simulation.FlightEvent;
74 import net.sf.openrocket.simulation.FlightEvent.Type;
75 import net.sf.openrocket.simulation.SimulationOptions;
76 import net.sf.openrocket.simulation.customexpression.CustomExpression;
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;
652 private boolean datatypesDefined = false;
654 public OpenRocketContentHandler(DocumentLoadingContext context) {
655 this.context = context;
656 this.rocket = new Rocket();
657 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("datatypes")) {
682 if (datatypesDefined) {
683 warnings.add(Warning.fromString("Multiple datatype blocks. Ignoring later ones."));
686 datatypesDefined = true;
687 return new DatatypeHandler(this, context);
690 if (element.equals("simulations")) {
691 if (simulationsDefined) {
693 .fromString("Multiple simulation definitions within one document, "
694 + "ignoring later ones."));
697 simulationsDefined = true;
698 return new SimulationsHandler(doc, context);
701 warnings.add(Warning.fromString("Unknown element " + element + ", ignoring."));
707 class DatatypeHandler extends AbstractElementHandler {
708 private final DocumentLoadingContext context;
709 private final OpenRocketContentHandler contentHandler;
710 private CustomExpressionHandler customExpressionHandler = null;
712 public DatatypeHandler(OpenRocketContentHandler contentHandler, DocumentLoadingContext context) {
713 this.context = context;
714 this.contentHandler = contentHandler;
718 public ElementHandler openElement(String element,
719 HashMap<String, String> attributes, WarningSet warnings)
720 throws SAXException {
722 if (element.equals("type") && attributes.get("source").equals("customexpression")) {
723 customExpressionHandler = new CustomExpressionHandler(contentHandler, context);
724 return customExpressionHandler;
727 warnings.add(Warning.fromString("Unknown datatype " + element + " defined, ignoring"));
734 public void closeElement(String element, HashMap<String, String> attributes, String content, WarningSet warnings) throws SAXException {
735 attributes.remove("source");
736 super.closeElement(element, attributes, content, warnings);
738 if (customExpressionHandler != null) {
739 contentHandler.getDocument().addCustomExpression(customExpressionHandler.currentExpression);
746 class CustomExpressionHandler extends AbstractElementHandler {
747 private final DocumentLoadingContext context;
748 private final OpenRocketContentHandler contentHandler;
749 public CustomExpression currentExpression;
751 public CustomExpressionHandler(OpenRocketContentHandler contentHandler, DocumentLoadingContext context) {
752 this.context = context;
753 this.contentHandler = contentHandler;
754 currentExpression = new CustomExpression(contentHandler.getDocument());
759 public ElementHandler openElement(String element,
760 HashMap<String, String> attributes, WarningSet warnings)
761 throws SAXException {
767 public void closeElement(String element, HashMap<String, String> attributes,
768 String content, WarningSet warnings) throws SAXException {
770 if (element.equals("type")) {
771 contentHandler.getDocument().addCustomExpression(currentExpression);
774 if (element.equals("name")) {
775 currentExpression.setName(content);
778 if (element.equals("symbol")) {
779 currentExpression.setSymbol(content);
782 if (element.equals("unit") && attributes.get("unittype").equals("auto")) {
783 currentExpression.setUnit(content);
786 if (element.equals("expression")) {
787 currentExpression.setExpression(content);
793 * A handler that creates components from the corresponding elements. The control of the
794 * contents is passed on to ComponentParameterHandler.
796 class ComponentHandler extends AbstractElementHandler {
797 private final DocumentLoadingContext context;
798 private final RocketComponent parent;
800 public ComponentHandler(RocketComponent parent, DocumentLoadingContext context) {
801 this.parent = parent;
802 this.context = context;
806 public ElementHandler openElement(String element, HashMap<String, String> attributes,
807 WarningSet warnings) {
809 // Attempt to construct new component
810 Constructor<? extends RocketComponent> constructor = DocumentConfig.constructors
812 if (constructor == null) {
813 warnings.add(Warning.fromString("Unknown element " + element + ", ignoring."));
819 c = constructor.newInstance();
820 } catch (InstantiationException e) {
821 throw new BugException("Error constructing component.", e);
822 } catch (IllegalAccessException e) {
823 throw new BugException("Error constructing component.", e);
824 } catch (InvocationTargetException e) {
825 throw Reflection.handleWrappedException(e);
830 return new ComponentParameterHandler(c, context);
836 * A handler that populates the parameters of a previously constructed rocket component.
837 * This uses the setters, or delegates the handling to another handler for specific
840 class ComponentParameterHandler extends AbstractElementHandler {
841 private final DocumentLoadingContext context;
842 private final RocketComponent component;
844 public ComponentParameterHandler(RocketComponent c, DocumentLoadingContext context) {
846 this.context = context;
850 public ElementHandler openElement(String element, HashMap<String, String> attributes,
851 WarningSet warnings) {
853 // Check for specific elements that contain other elements
854 if (element.equals("subcomponents")) {
855 return new ComponentHandler(component, context);
857 if (element.equals("motormount")) {
858 if (!(component instanceof MotorMount)) {
859 warnings.add(Warning.fromString("Illegal component defined as motor mount."));
862 return new MotorMountHandler((MotorMount) component, context);
864 if (element.equals("finpoints")) {
865 if (!(component instanceof FreeformFinSet)) {
866 warnings.add(Warning.fromString("Illegal component defined for fin points."));
869 return new FinSetPointHandler((FreeformFinSet) component, context);
871 if (element.equals("motorconfiguration")) {
872 if (!(component instanceof Rocket)) {
873 warnings.add(Warning.fromString("Illegal component defined for motor configuration."));
876 return new MotorConfigurationHandler((Rocket) component, context);
880 return PlainTextHandler.INSTANCE;
884 public void closeElement(String element, HashMap<String, String> attributes,
885 String content, WarningSet warnings) {
887 if (element.equals("subcomponents") || element.equals("motormount") ||
888 element.equals("finpoints") || element.equals("motorconfiguration")) {
892 // Search for the correct setter class
895 for (c = component.getClass(); c != null; c = c.getSuperclass()) {
896 String setterKey = c.getSimpleName() + ":" + element;
897 Setter s = DocumentConfig.setters.get(setterKey);
900 s.set(component, content, attributes, warnings);
903 if (DocumentConfig.setters.containsKey(setterKey)) {
904 // Key exists but is null -> invalid parameter
910 warnings.add(Warning.fromString("Unknown parameter type '" + element + "' for "
911 + component.getComponentName() + ", ignoring."));
918 * A handler that reads the <point> specifications within the freeformfinset's
919 * <finpoints> elements.
921 class FinSetPointHandler extends AbstractElementHandler {
922 @SuppressWarnings("unused")
923 private final DocumentLoadingContext context;
924 private final FreeformFinSet finset;
925 private final ArrayList<Coordinate> coordinates = new ArrayList<Coordinate>();
927 public FinSetPointHandler(FreeformFinSet finset, DocumentLoadingContext context) {
928 this.finset = finset;
929 this.context = context;
933 public ElementHandler openElement(String element, HashMap<String, String> attributes,
934 WarningSet warnings) {
935 return PlainTextHandler.INSTANCE;
940 public void closeElement(String element, HashMap<String, String> attributes,
941 String content, WarningSet warnings) throws SAXException {
943 String strx = attributes.remove("x");
944 String stry = attributes.remove("y");
945 if (strx == null || stry == null) {
946 warnings.add(Warning.fromString("Illegal fin points specification, ignoring."));
950 double x = Double.parseDouble(strx);
951 double y = Double.parseDouble(stry);
952 coordinates.add(new Coordinate(x, y));
953 } catch (NumberFormatException e) {
954 warnings.add(Warning.fromString("Illegal fin points specification, ignoring."));
958 super.closeElement(element, attributes, content, warnings);
962 public void endHandler(String element, HashMap<String, String> attributes,
963 String content, WarningSet warnings) {
965 finset.setPoints(coordinates.toArray(new Coordinate[0]));
966 } catch (IllegalFinPointException e) {
967 warnings.add(Warning.fromString("Freeform fin set point definitions illegal, ignoring."));
973 class MotorMountHandler extends AbstractElementHandler {
974 private final DocumentLoadingContext context;
975 private final MotorMount mount;
976 private MotorHandler motorHandler;
978 public MotorMountHandler(MotorMount mount, DocumentLoadingContext context) {
980 this.context = context;
981 mount.setMotorMount(true);
985 public ElementHandler openElement(String element, HashMap<String, String> attributes,
986 WarningSet warnings) {
988 if (element.equals("motor")) {
989 motorHandler = new MotorHandler(context);
993 if (element.equals("ignitionevent") ||
994 element.equals("ignitiondelay") ||
995 element.equals("overhang")) {
996 return PlainTextHandler.INSTANCE;
999 warnings.add(Warning.fromString("Unknown element '" + element + "' encountered, ignoring."));
1006 public void closeElement(String element, HashMap<String, String> attributes,
1007 String content, WarningSet warnings) throws SAXException {
1009 if (element.equals("motor")) {
1010 String id = attributes.get("configid");
1011 if (id == null || id.equals("")) {
1012 warnings.add(Warning.fromString("Illegal motor specification, ignoring."));
1016 Motor motor = motorHandler.getMotor(warnings);
1017 mount.setMotor(id, motor);
1018 mount.setMotorDelay(id, motorHandler.getDelay(warnings));
1022 if (element.equals("ignitionevent")) {
1023 MotorMount.IgnitionEvent event = null;
1024 for (MotorMount.IgnitionEvent e : MotorMount.IgnitionEvent.values()) {
1025 if (e.name().toLowerCase(Locale.ENGLISH).replaceAll("_", "").equals(content)) {
1030 if (event == null) {
1031 warnings.add(Warning.fromString("Unknown ignition event type '" + content + "', ignoring."));
1034 mount.setIgnitionEvent(event);
1038 if (element.equals("ignitiondelay")) {
1041 d = Double.parseDouble(content);
1042 } catch (NumberFormatException nfe) {
1043 warnings.add(Warning.fromString("Illegal ignition delay specified, ignoring."));
1046 mount.setIgnitionDelay(d);
1050 if (element.equals("overhang")) {
1053 d = Double.parseDouble(content);
1054 } catch (NumberFormatException nfe) {
1055 warnings.add(Warning.fromString("Illegal overhang specified, ignoring."));
1058 mount.setMotorOverhang(d);
1062 super.closeElement(element, attributes, content, warnings);
1069 class MotorConfigurationHandler extends AbstractElementHandler {
1070 @SuppressWarnings("unused")
1071 private final DocumentLoadingContext context;
1072 private final Rocket rocket;
1073 private String name = null;
1074 private boolean inNameElement = false;
1076 public MotorConfigurationHandler(Rocket rocket, DocumentLoadingContext context) {
1077 this.rocket = rocket;
1078 this.context = context;
1082 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1083 WarningSet warnings) {
1085 if (inNameElement || !element.equals("name")) {
1086 warnings.add(Warning.FILE_INVALID_PARAMETER);
1089 inNameElement = true;
1091 return PlainTextHandler.INSTANCE;
1095 public void closeElement(String element, HashMap<String, String> attributes,
1096 String content, WarningSet warnings) {
1101 public void endHandler(String element, HashMap<String, String> attributes,
1102 String content, WarningSet warnings) throws SAXException {
1104 String configid = attributes.remove("configid");
1105 if (configid == null || configid.equals("")) {
1106 warnings.add(Warning.FILE_INVALID_PARAMETER);
1110 if (!rocket.addMotorConfigurationID(configid)) {
1111 warnings.add("Duplicate motor configuration ID used.");
1115 if (name != null && name.trim().length() > 0) {
1116 rocket.setMotorConfigurationName(configid, name);
1119 if ("true".equals(attributes.remove("default"))) {
1120 rocket.getDefaultConfiguration().setMotorConfigurationID(configid);
1123 super.closeElement(element, attributes, content, warnings);
1128 class MotorHandler extends AbstractElementHandler {
1129 /** File version where latest digest format was introduced */
1130 private static final int MOTOR_DIGEST_VERSION = 104;
1132 private final DocumentLoadingContext context;
1133 private Motor.Type type = null;
1134 private String manufacturer = null;
1135 private String designation = null;
1136 private String digest = null;
1137 private double diameter = Double.NaN;
1138 private double length = Double.NaN;
1139 private double delay = Double.NaN;
1141 public MotorHandler(DocumentLoadingContext context) {
1142 this.context = context;
1147 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1148 WarningSet warnings) {
1149 return PlainTextHandler.INSTANCE;
1154 * Return the motor to use, or null.
1156 public Motor getMotor(WarningSet warnings) {
1157 return context.getMotorFinder().findMotor(type, manufacturer, designation, diameter, length, digest, warnings);
1161 * Return the delay to use for the motor.
1163 public double getDelay(WarningSet warnings) {
1164 if (Double.isNaN(delay)) {
1165 warnings.add(Warning.fromString("Motor delay not specified, assuming no ejection charge."));
1166 return Motor.PLUGGED;
1173 public void closeElement(String element, HashMap<String, String> attributes,
1174 String content, WarningSet warnings) throws SAXException {
1176 content = content.trim();
1178 if (element.equals("type")) {
1182 for (Motor.Type t : Motor.Type.values()) {
1183 if (t.name().toLowerCase(Locale.ENGLISH).equals(content.trim())) {
1189 warnings.add(Warning.fromString("Unknown motor type '" + content + "', ignoring."));
1192 } else if (element.equals("manufacturer")) {
1195 manufacturer = content.trim();
1197 } else if (element.equals("designation")) {
1200 designation = content.trim();
1202 } else if (element.equals("digest")) {
1204 // Digest is used only for file versions saved using the same digest algorithm
1205 if (context.getFileVersion() >= MOTOR_DIGEST_VERSION) {
1206 digest = content.trim();
1209 } else if (element.equals("diameter")) {
1212 diameter = Double.NaN;
1214 diameter = Double.parseDouble(content.trim());
1215 } catch (NumberFormatException e) {
1218 if (Double.isNaN(diameter)) {
1219 warnings.add(Warning.fromString("Illegal motor diameter specified, ignoring."));
1222 } else if (element.equals("length")) {
1225 length = Double.NaN;
1227 length = Double.parseDouble(content.trim());
1228 } catch (NumberFormatException ignore) {
1231 if (Double.isNaN(length)) {
1232 warnings.add(Warning.fromString("Illegal motor diameter specified, ignoring."));
1235 } else if (element.equals("delay")) {
1239 if (content.equals("none")) {
1240 delay = Motor.PLUGGED;
1243 delay = Double.parseDouble(content.trim());
1244 } catch (NumberFormatException ignore) {
1247 if (Double.isNaN(delay)) {
1248 warnings.add(Warning.fromString("Illegal motor delay specified, ignoring."));
1254 super.closeElement(element, attributes, content, warnings);
1262 class SimulationsHandler extends AbstractElementHandler {
1263 private final DocumentLoadingContext context;
1264 private final OpenRocketDocument doc;
1265 private SingleSimulationHandler handler;
1267 public SimulationsHandler(OpenRocketDocument doc, DocumentLoadingContext context) {
1269 this.context = context;
1273 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1274 WarningSet warnings) {
1276 if (!element.equals("simulation")) {
1277 warnings.add("Unknown element '" + element + "', ignoring.");
1281 handler = new SingleSimulationHandler(doc, context);
1286 public void closeElement(String element, HashMap<String, String> attributes,
1287 String content, WarningSet warnings) throws SAXException {
1288 attributes.remove("status");
1290 //Finished loading. Rebuilding custom expressions in case something has changed such as listener variable come available.
1291 for (CustomExpression exp : doc.getCustomExpressions()){
1292 exp.setExpression(exp.getExpressionString());
1295 super.closeElement(element, attributes, content, warnings);
1299 class SingleSimulationHandler extends AbstractElementHandler {
1301 private final DocumentLoadingContext context;
1303 private final OpenRocketDocument doc;
1305 private String name;
1307 private SimulationConditionsHandler conditionHandler;
1308 private FlightDataHandler dataHandler;
1310 private final List<String> listeners = new ArrayList<String>();
1312 public SingleSimulationHandler(OpenRocketDocument doc, DocumentLoadingContext context) {
1314 this.context = context;
1317 public OpenRocketDocument getDocument() {
1322 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1323 WarningSet warnings) {
1325 if (element.equals("name") || element.equals("simulator") ||
1326 element.equals("calculator") || element.equals("listener")) {
1327 return PlainTextHandler.INSTANCE;
1328 } else if (element.equals("conditions")) {
1329 conditionHandler = new SimulationConditionsHandler(doc.getRocket(), context);
1330 return conditionHandler;
1331 } else if (element.equals("flightdata")) {
1332 dataHandler = new FlightDataHandler(this, context);
1335 warnings.add("Unknown element '" + element + "', ignoring.");
1341 public void closeElement(String element, HashMap<String, String> attributes,
1342 String content, WarningSet warnings) {
1344 if (element.equals("name")) {
1346 } else if (element.equals("simulator")) {
1347 if (!content.trim().equals("RK4Simulator")) {
1348 warnings.add("Unknown simulator '" + content.trim() + "' specified, ignoring.");
1350 } else if (element.equals("calculator")) {
1351 if (!content.trim().equals("BarrowmanCalculator")) {
1352 warnings.add("Unknown calculator '" + content.trim() + "' specified, ignoring.");
1354 } else if (element.equals("listener") && content.trim().length() > 0) {
1355 listeners.add(content.trim());
1361 public void endHandler(String element, HashMap<String, String> attributes,
1362 String content, WarningSet warnings) {
1364 String s = attributes.get("status");
1365 Simulation.Status status = (Status) DocumentConfig.findEnum(s, Simulation.Status.class);
1366 if (status == null) {
1367 warnings.add("Simulation status unknown, assuming outdated.");
1368 status = Simulation.Status.OUTDATED;
1371 SimulationOptions conditions;
1372 if (conditionHandler != null) {
1373 conditions = conditionHandler.getConditions();
1375 warnings.add("Simulation conditions not defined, using defaults.");
1376 conditions = new SimulationOptions(doc.getRocket());
1380 name = "Simulation";
1383 if (dataHandler == null)
1386 data = dataHandler.getFlightData();
1388 Simulation simulation = new Simulation(doc.getRocket(), status, name,
1389 conditions, listeners, data);
1391 doc.addSimulation(simulation);
1395 class SimulationConditionsHandler extends AbstractElementHandler {
1396 private final DocumentLoadingContext context;
1397 private SimulationOptions conditions;
1398 private AtmosphereHandler atmosphereHandler;
1400 public SimulationConditionsHandler(Rocket rocket, DocumentLoadingContext context) {
1401 this.context = context;
1402 conditions = new SimulationOptions(rocket);
1403 // Set up default loading settings (which may differ from the new defaults)
1404 conditions.setGeodeticComputation(GeodeticComputationStrategy.FLAT);
1407 public SimulationOptions getConditions() {
1412 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1413 WarningSet warnings) {
1414 if (element.equals("atmosphere")) {
1415 atmosphereHandler = new AtmosphereHandler(attributes.get("model"), context);
1416 return atmosphereHandler;
1418 return PlainTextHandler.INSTANCE;
1422 public void closeElement(String element, HashMap<String, String> attributes,
1423 String content, WarningSet warnings) {
1425 double d = Double.NaN;
1427 d = Double.parseDouble(content);
1428 } catch (NumberFormatException ignore) {
1432 if (element.equals("configid")) {
1433 if (content.equals("")) {
1434 conditions.setMotorConfigurationID(null);
1436 conditions.setMotorConfigurationID(content);
1438 } else if (element.equals("launchrodlength")) {
1439 if (Double.isNaN(d)) {
1440 warnings.add("Illegal launch rod length defined, ignoring.");
1442 conditions.setLaunchRodLength(d);
1444 } else if (element.equals("launchrodangle")) {
1445 if (Double.isNaN(d)) {
1446 warnings.add("Illegal launch rod angle defined, ignoring.");
1448 conditions.setLaunchRodAngle(d * Math.PI / 180);
1450 } else if (element.equals("launchroddirection")) {
1451 if (Double.isNaN(d)) {
1452 warnings.add("Illegal launch rod direction defined, ignoring.");
1454 conditions.setLaunchRodDirection(d * Math.PI / 180);
1456 } else if (element.equals("windaverage")) {
1457 if (Double.isNaN(d)) {
1458 warnings.add("Illegal average windspeed defined, ignoring.");
1460 conditions.setWindSpeedAverage(d);
1462 } else if (element.equals("windturbulence")) {
1463 if (Double.isNaN(d)) {
1464 warnings.add("Illegal wind turbulence intensity defined, ignoring.");
1466 conditions.setWindTurbulenceIntensity(d);
1468 } else if (element.equals("launchaltitude")) {
1469 if (Double.isNaN(d)) {
1470 warnings.add("Illegal launch altitude defined, ignoring.");
1472 conditions.setLaunchAltitude(d);
1474 } else if (element.equals("launchlatitude")) {
1475 if (Double.isNaN(d)) {
1476 warnings.add("Illegal launch latitude defined, ignoring.");
1478 conditions.setLaunchLatitude(d);
1480 } else if (element.equals("launchlongitude")) {
1481 if (Double.isNaN(d)) {
1482 warnings.add("Illegal launch longitude.");
1484 conditions.setLaunchLongitude(d);
1486 } else if (element.equals("geodeticmethod")) {
1487 GeodeticComputationStrategy gcs =
1488 (GeodeticComputationStrategy) DocumentConfig.findEnum(content, GeodeticComputationStrategy.class);
1490 conditions.setGeodeticComputation(gcs);
1492 warnings.add("Unknown geodetic computation method '" + content + "'");
1494 } else if (element.equals("atmosphere")) {
1495 atmosphereHandler.storeSettings(conditions, warnings);
1496 } else if (element.equals("timestep")) {
1497 if (Double.isNaN(d)) {
1498 warnings.add("Illegal time step defined, ignoring.");
1500 conditions.setTimeStep(d);
1507 class AtmosphereHandler extends AbstractElementHandler {
1508 @SuppressWarnings("unused")
1509 private final DocumentLoadingContext context;
1510 private final String model;
1511 private double temperature = Double.NaN;
1512 private double pressure = Double.NaN;
1514 public AtmosphereHandler(String model, DocumentLoadingContext context) {
1516 this.context = context;
1520 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1521 WarningSet warnings) {
1522 return PlainTextHandler.INSTANCE;
1526 public void closeElement(String element, HashMap<String, String> attributes,
1527 String content, WarningSet warnings) throws SAXException {
1529 double d = Double.NaN;
1531 d = Double.parseDouble(content);
1532 } catch (NumberFormatException ignore) {
1535 if (element.equals("basetemperature")) {
1536 if (Double.isNaN(d)) {
1537 warnings.add("Illegal base temperature specified, ignoring.");
1540 } else if (element.equals("basepressure")) {
1541 if (Double.isNaN(d)) {
1542 warnings.add("Illegal base pressure specified, ignoring.");
1546 super.closeElement(element, attributes, content, warnings);
1551 public void storeSettings(SimulationOptions cond, WarningSet warnings) {
1552 if (!Double.isNaN(pressure)) {
1553 cond.setLaunchPressure(pressure);
1555 if (!Double.isNaN(temperature)) {
1556 cond.setLaunchTemperature(temperature);
1559 if ("isa".equals(model)) {
1560 cond.setISAAtmosphere(true);
1561 } else if ("extendedisa".equals(model)) {
1562 cond.setISAAtmosphere(false);
1564 cond.setISAAtmosphere(true);
1565 warnings.add("Unknown atmospheric model, using ISA.");
1572 class FlightDataHandler extends AbstractElementHandler {
1573 private final DocumentLoadingContext context;
1575 private FlightDataBranchHandler dataHandler;
1576 private WarningSet warningSet = new WarningSet();
1577 private List<FlightDataBranch> branches = new ArrayList<FlightDataBranch>();
1579 private SingleSimulationHandler simHandler;
1580 private FlightData data;
1583 public FlightDataHandler(SingleSimulationHandler simHandler, DocumentLoadingContext context) {
1584 this.context = context;
1585 this.simHandler = simHandler;
1588 public FlightData getFlightData() {
1593 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1594 WarningSet warnings) {
1596 if (element.equals("warning")) {
1597 return PlainTextHandler.INSTANCE;
1599 if (element.equals("databranch")) {
1600 if (attributes.get("name") == null || attributes.get("types") == null) {
1601 warnings.add("Illegal flight data definition, ignoring.");
1604 dataHandler = new FlightDataBranchHandler(attributes.get("name"),
1605 attributes.get("types"),
1606 simHandler, context);
1610 warnings.add("Unknown element '" + element + "' encountered, ignoring.");
1616 public void closeElement(String element, HashMap<String, String> attributes,
1617 String content, WarningSet warnings) {
1619 if (element.equals("databranch")) {
1620 FlightDataBranch branch = dataHandler.getBranch();
1621 if (branch.getLength() > 0) {
1622 branches.add(branch);
1624 } else if (element.equals("warning")) {
1625 warningSet.add(Warning.fromString(content));
1631 public void endHandler(String element, HashMap<String, String> attributes,
1632 String content, WarningSet warnings) {
1634 if (branches.size() > 0) {
1635 data = new FlightData(branches.toArray(new FlightDataBranch[0]));
1637 double maxAltitude = Double.NaN;
1638 double maxVelocity = Double.NaN;
1639 double maxAcceleration = Double.NaN;
1640 double maxMach = Double.NaN;
1641 double timeToApogee = Double.NaN;
1642 double flightTime = Double.NaN;
1643 double groundHitVelocity = Double.NaN;
1644 double launchRodVelocity = Double.NaN;
1645 double deploymentVelocity = Double.NaN;
1648 maxAltitude = DocumentConfig.stringToDouble(attributes.get("maxaltitude"));
1649 } catch (NumberFormatException ignore) {
1652 maxVelocity = DocumentConfig.stringToDouble(attributes.get("maxvelocity"));
1653 } catch (NumberFormatException ignore) {
1656 maxAcceleration = DocumentConfig.stringToDouble(attributes.get("maxacceleration"));
1657 } catch (NumberFormatException ignore) {
1660 maxMach = DocumentConfig.stringToDouble(attributes.get("maxmach"));
1661 } catch (NumberFormatException ignore) {
1664 timeToApogee = DocumentConfig.stringToDouble(attributes.get("timetoapogee"));
1665 } catch (NumberFormatException ignore) {
1668 flightTime = DocumentConfig.stringToDouble(attributes.get("flighttime"));
1669 } catch (NumberFormatException ignore) {
1673 DocumentConfig.stringToDouble(attributes.get("groundhitvelocity"));
1674 } catch (NumberFormatException ignore) {
1677 launchRodVelocity = DocumentConfig.stringToDouble(attributes.get("launchrodvelocity"));
1678 } catch (NumberFormatException ignore) {
1681 deploymentVelocity = DocumentConfig.stringToDouble(attributes.get("deploymentvelocity"));
1682 } catch (NumberFormatException ignore) {
1685 data = new FlightData(maxAltitude, maxVelocity, maxAcceleration, maxMach,
1686 timeToApogee, flightTime, groundHitVelocity, launchRodVelocity, deploymentVelocity);
1689 data.getWarningSet().addAll(warningSet);
1697 class FlightDataBranchHandler extends AbstractElementHandler {
1698 @SuppressWarnings("unused")
1699 private final DocumentLoadingContext context;
1700 private final FlightDataType[] types;
1701 private final FlightDataBranch branch;
1703 private static final LogHelper log = Application.getLogger();
1704 private final SingleSimulationHandler simHandler;
1706 public FlightDataBranchHandler(String name, String typeList, SingleSimulationHandler simHandler, DocumentLoadingContext context) {
1707 this.simHandler = simHandler;
1708 this.context = context;
1709 String[] split = typeList.split(",");
1710 types = new FlightDataType[split.length];
1711 for (int i = 0; i < split.length; i++) {
1712 String typeName = split[i];
1713 FlightDataType matching = findFlightDataType(typeName);
1714 types[i] = matching;
1715 //types[i] = FlightDataType.getType(typeName, matching.getSymbol(), matching.getUnitGroup());
1718 // TODO: LOW: May throw an IllegalArgumentException
1719 branch = new FlightDataBranch(name, types);
1722 // Find the full flight data type given name only
1723 // Note: this way of doing it requires that custom expressions always come before flight data in the file,
1724 // not the nicest but this is always the case anyway.
1725 private FlightDataType findFlightDataType(String name) {
1727 // Kevins version with lookup by key. Not using right now
1729 if ( key != null ) {
1730 for (FlightDataType t : FlightDataType.ALL_TYPES){
1731 if (t.getKey().equals(key) ){
1738 // Look in built in types
1739 for (FlightDataType t : FlightDataType.ALL_TYPES) {
1740 if (t.getName().equals(name)) {
1745 // Look in custom expressions
1746 for (CustomExpression exp : simHandler.getDocument().getCustomExpressions()) {
1747 if (exp.getName().equals(name)) {
1748 return exp.getType();
1752 log.warn("Could not find the flight data type '" + name + "' used in the XML file. Substituted type with unknown symbol and units.");
1753 return FlightDataType.getType(name, "Unknown", UnitGroup.UNITS_NONE);
1756 public FlightDataBranch getBranch() {
1762 public ElementHandler openElement(String element, HashMap<String, String> attributes,
1763 WarningSet warnings) {
1765 if (element.equals("datapoint"))
1766 return PlainTextHandler.INSTANCE;
1767 if (element.equals("event"))
1768 return PlainTextHandler.INSTANCE;
1770 warnings.add("Unknown element '" + element + "' encountered, ignoring.");
1776 public void closeElement(String element, HashMap<String, String> attributes,
1777 String content, WarningSet warnings) {
1779 if (element.equals("event")) {
1781 FlightEvent.Type type;
1784 time = DocumentConfig.stringToDouble(attributes.get("time"));
1785 } catch (NumberFormatException e) {
1786 warnings.add("Illegal event specification, ignoring.");
1790 type = (Type) DocumentConfig.findEnum(attributes.get("type"), FlightEvent.Type.class);
1792 warnings.add("Illegal event specification, ignoring.");
1796 branch.addEvent(new FlightEvent(type, time));
1800 if (!element.equals("datapoint")) {
1801 warnings.add("Unknown element '" + element + "' encountered, ignoring.");
1805 // element == "datapoint"
1808 // Check line format
1809 String[] split = content.split(",");
1810 if (split.length != types.length) {
1811 warnings.add("Data point did not contain correct amount of values, ignoring point.");
1815 // Parse the doubles
1816 double[] values = new double[split.length];
1817 for (int i = 0; i < values.length; i++) {
1819 values[i] = DocumentConfig.stringToDouble(split[i]);
1820 } catch (NumberFormatException e) {
1821 warnings.add("Data point format error, ignoring point.");
1826 // Add point to branch
1828 for (int i = 0; i < types.length; i++) {
1829 branch.setValue(types[i], values[i]);
1838 ///////////////// Setters implementation
1844 * Set the specified value to the given component.
1846 * @param component the component to which to set.
1847 * @param value the value within the element.
1848 * @param attributes attributes for the element.
1849 * @param warnings the warning set to use.
1851 public void set(RocketComponent component, String value,
1852 HashMap<String, String> attributes, WarningSet warnings);
1856 //// StringSetter - sets the value to the contained String
1857 class StringSetter implements Setter {
1858 private final Reflection.Method setMethod;
1860 public StringSetter(Reflection.Method set) {
1865 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1866 WarningSet warnings) {
1867 setMethod.invoke(c, s);
1871 //// IntSetter - set an integer value
1872 class IntSetter implements Setter {
1873 private final Reflection.Method setMethod;
1875 public IntSetter(Reflection.Method set) {
1880 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1881 WarningSet warnings) {
1883 int n = Integer.parseInt(s);
1884 setMethod.invoke(c, n);
1885 } catch (NumberFormatException e) {
1886 warnings.add(Warning.FILE_INVALID_PARAMETER);
1892 //// BooleanSetter - set a boolean value
1893 class BooleanSetter implements Setter {
1894 private final Reflection.Method setMethod;
1896 public BooleanSetter(Reflection.Method set) {
1901 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1902 WarningSet warnings) {
1905 if (s.equalsIgnoreCase("true")) {
1906 setMethod.invoke(c, true);
1907 } else if (s.equalsIgnoreCase("false")) {
1908 setMethod.invoke(c, false);
1910 warnings.add(Warning.FILE_INVALID_PARAMETER);
1917 //// DoubleSetter - sets a double value or (alternatively) if a specific string is encountered
1918 //// calls a setXXX(boolean) method.
1919 class DoubleSetter implements Setter {
1920 private final Reflection.Method setMethod;
1921 private final String specialString;
1922 private final Reflection.Method specialMethod;
1923 private final double multiplier;
1926 * Set only the double value.
1927 * @param set set method for the double value.
1929 public DoubleSetter(Reflection.Method set) {
1930 this.setMethod = set;
1931 this.specialString = null;
1932 this.specialMethod = null;
1933 this.multiplier = 1.0;
1937 * Multiply with the given multiplier and set the double value.
1938 * @param set set method for the double value.
1939 * @param mul multiplier.
1941 public DoubleSetter(Reflection.Method set, double mul) {
1942 this.setMethod = set;
1943 this.specialString = null;
1944 this.specialMethod = null;
1945 this.multiplier = mul;
1949 * Set the double value, or if the value equals the special string, use the
1950 * special setter and set it to true.
1952 * @param set double setter.
1953 * @param special special string
1954 * @param specialMethod boolean setter.
1956 public DoubleSetter(Reflection.Method set, String special,
1957 Reflection.Method specialMethod) {
1958 this.setMethod = set;
1959 this.specialString = special;
1960 this.specialMethod = specialMethod;
1961 this.multiplier = 1.0;
1966 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1967 WarningSet warnings) {
1971 // Check for special case
1972 if (specialMethod != null && s.equalsIgnoreCase(specialString)) {
1973 specialMethod.invoke(c, true);
1979 double d = Double.parseDouble(s);
1980 setMethod.invoke(c, d * multiplier);
1981 } catch (NumberFormatException e) {
1982 warnings.add(Warning.FILE_INVALID_PARAMETER);
1988 class OverrideSetter implements Setter {
1989 private final Reflection.Method setMethod;
1990 private final Reflection.Method enabledMethod;
1992 public OverrideSetter(Reflection.Method set, Reflection.Method enabledMethod) {
1993 this.setMethod = set;
1994 this.enabledMethod = enabledMethod;
1998 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
1999 WarningSet warnings) {
2002 double d = Double.parseDouble(s);
2003 setMethod.invoke(c, d);
2004 enabledMethod.invoke(c, true);
2005 } catch (NumberFormatException e) {
2006 warnings.add(Warning.FILE_INVALID_PARAMETER);
2011 //// EnumSetter - sets a generic enum type
2012 class EnumSetter<T extends Enum<T>> implements Setter {
2013 private final Reflection.Method setter;
2014 private final Class<T> enumClass;
2016 public EnumSetter(Reflection.Method set, Class<T> enumClass) {
2018 this.enumClass = enumClass;
2022 public void set(RocketComponent c, String name, HashMap<String, String> attributes,
2023 WarningSet warnings) {
2025 Enum<?> setEnum = DocumentConfig.findEnum(name, enumClass);
2026 if (setEnum == null) {
2027 warnings.add(Warning.FILE_INVALID_PARAMETER);
2031 setter.invoke(c, setEnum);
2036 //// ColorSetter - sets a Color value
2037 class ColorSetter implements Setter {
2038 private final Reflection.Method setMethod;
2040 public ColorSetter(Reflection.Method set) {
2045 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
2046 WarningSet warnings) {
2048 String red = attributes.get("red");
2049 String green = attributes.get("green");
2050 String blue = attributes.get("blue");
2052 if (red == null || green == null || blue == null) {
2053 warnings.add(Warning.FILE_INVALID_PARAMETER);
2059 r = Integer.parseInt(red);
2060 g = Integer.parseInt(green);
2061 b = Integer.parseInt(blue);
2062 } catch (NumberFormatException e) {
2063 warnings.add(Warning.FILE_INVALID_PARAMETER);
2067 if (r < 0 || g < 0 || b < 0 || r > 255 || g > 255 || b > 255) {
2068 warnings.add(Warning.FILE_INVALID_PARAMETER);
2072 Color color = new Color(r, g, b);
2073 setMethod.invoke(c, color);
2075 if (!s.trim().equals("")) {
2076 warnings.add(Warning.FILE_INVALID_PARAMETER);
2081 ////ComponentPresetSetter - sets a ComponentPreset value
2082 class ComponentPresetSetter implements Setter {
2083 private final Reflection.Method setMethod;
2085 public ComponentPresetSetter(Reflection.Method set) {
2086 this.setMethod = set;
2090 public void set(RocketComponent c, String name, HashMap<String, String> attributes,
2091 WarningSet warnings) {
2092 String manufacturerName = attributes.get("manufacturer");
2093 if (manufacturerName == null) {
2094 warnings.add(Warning.fromString("Invalid ComponentPreset for component " + c.getName() + ", no manufacturer specified. Ignored"));
2098 String productNo = attributes.get("partno");
2099 if (productNo == null) {
2100 warnings.add(Warning.fromString("Invalid ComponentPreset for component " + c.getName() + ", no partno specified. Ignored"));
2104 String digest = attributes.get("digest");
2105 if (digest == null) {
2106 warnings.add(Warning.fromString("Invalid ComponentPreset for component " + c.getName() + ", no digest specified."));
2109 String type = attributes.get("type");
2111 warnings.add(Warning.fromString("Invalid ComponentPreset for component " + c.getName() + ", no type specified."));
2114 List<ComponentPreset> presets = Application.getComponentPresetDao().find(manufacturerName, productNo);
2116 ComponentPreset matchingPreset = null;
2118 for (ComponentPreset preset : presets) {
2119 if (digest != null && preset.getDigest().equals(digest)) {
2120 // Found one with matching digest. Take it.
2121 matchingPreset = preset;
2124 if (type != null && preset.getType().name().equals(type) && matchingPreset != null) {
2125 // Found the first one with matching type.
2126 matchingPreset = preset;
2131 if (matchingPreset == null) {
2132 warnings.add(Warning.fromString("No matching ComponentPreset for component " + c.getName() + " found matching " + manufacturerName + " " + productNo));
2136 if (digest != null && !matchingPreset.getDigest().equals(digest)) {
2137 warnings.add(Warning.fromString("ComponentPreset for component " + c.getName() + " has wrong digest"));
2140 setMethod.invoke(c, matchingPreset);
2145 ////MaterialSetter - sets a Material value
2146 class MaterialSetter implements Setter {
2147 private final Reflection.Method setMethod;
2148 private final Material.Type type;
2150 public MaterialSetter(Reflection.Method set, Material.Type type) {
2151 this.setMethod = set;
2156 public void set(RocketComponent c, String name, HashMap<String, String> attributes,
2157 WarningSet warnings) {
2163 if (name.equals("")) {
2164 warnings.add(Warning.fromString("Illegal material specification, ignoring."));
2171 str = attributes.remove("density");
2173 warnings.add(Warning.fromString("Illegal material specification, ignoring."));
2177 density = Double.parseDouble(str);
2178 } catch (NumberFormatException e) {
2179 warnings.add(Warning.fromString("Illegal material specification, ignoring."));
2184 // double thickness = 0;
2185 // str = attributes.remove("thickness");
2188 // thickness = Double.parseDouble(str);
2189 // } catch (NumberFormatException e){
2190 // warnings.add(Warning.fromString("Illegal material specification, ignoring."));
2194 // Check type if specified
2195 str = attributes.remove("type");
2196 if (str != null && !type.name().toLowerCase(Locale.ENGLISH).equals(str)) {
2197 warnings.add(Warning.fromString("Illegal material type specified, ignoring."));
2201 mat = Databases.findMaterial(type, name, density);
2203 setMethod.invoke(c, mat);
2211 class PositionSetter implements Setter {
2214 public void set(RocketComponent c, String value, HashMap<String, String> attributes,
2215 WarningSet warnings) {
2217 RocketComponent.Position type = (Position) DocumentConfig.findEnum(attributes.get("type"),
2218 RocketComponent.Position.class);
2220 warnings.add(Warning.FILE_INVALID_PARAMETER);
2226 pos = Double.parseDouble(value);
2227 } catch (NumberFormatException e) {
2228 warnings.add(Warning.FILE_INVALID_PARAMETER);
2232 if (c instanceof FinSet) {
2233 ((FinSet) c).setRelativePosition(type);
2234 c.setPositionValue(pos);
2235 } else if (c instanceof LaunchLug) {
2236 ((LaunchLug) c).setRelativePosition(type);
2237 c.setPositionValue(pos);
2238 } else if (c instanceof InternalComponent) {
2239 ((InternalComponent) c).setRelativePosition(type);
2240 c.setPositionValue(pos);
2242 warnings.add(Warning.FILE_INVALID_PARAMETER);
2249 class FinTabPositionSetter extends DoubleSetter {
2251 public FinTabPositionSetter() {
2252 super(Reflection.findMethod(FinSet.class, "setTabShift", double.class));
2256 public void set(RocketComponent c, String s, HashMap<String, String> attributes,
2257 WarningSet warnings) {
2259 if (!(c instanceof FinSet)) {
2260 throw new IllegalStateException("FinTabPositionSetter called for component " + c);
2263 String relative = attributes.get("relativeto");
2264 FinSet.TabRelativePosition position =
2265 (TabRelativePosition) DocumentConfig.findEnum(relative,
2266 FinSet.TabRelativePosition.class);
2268 if (position != null) {
2270 ((FinSet) c).setTabRelativePosition(position);
2273 if (relative == null) {
2274 warnings.add("Required attribute 'relativeto' not found for fin tab position.");
2276 warnings.add("Illegal attribute value '" + relative + "' encountered.");
2280 super.set(c, s, attributes, warnings);
2287 class ClusterConfigurationSetter implements Setter {
2290 public void set(RocketComponent component, String value, HashMap<String, String> attributes,
2291 WarningSet warnings) {
2293 if (!(component instanceof Clusterable)) {
2294 warnings.add("Illegal component defined as cluster.");
2298 ClusterConfiguration config = null;
2299 for (ClusterConfiguration c : ClusterConfiguration.CONFIGURATIONS) {
2300 if (c.getXMLName().equals(value)) {
2306 if (config == null) {
2307 warnings.add("Illegal cluster configuration specified.");
2311 ((Clusterable) component).setClusterConfiguration(config);