1 package net.sf.openrocket.file.openrocket;
3 import java.io.BufferedWriter;
4 import java.io.IOException;
5 import java.io.OutputStream;
6 import java.io.OutputStreamWriter;
8 import java.util.ArrayList;
9 import java.util.Iterator;
10 import java.util.List;
11 import java.util.zip.GZIPOutputStream;
13 import net.sf.openrocket.aerodynamics.Warning;
14 import net.sf.openrocket.document.OpenRocketDocument;
15 import net.sf.openrocket.document.Simulation;
16 import net.sf.openrocket.document.StorageOptions;
17 import net.sf.openrocket.file.RocketSaver;
18 import net.sf.openrocket.logging.LogHelper;
19 import net.sf.openrocket.rocketcomponent.FinSet;
20 import net.sf.openrocket.rocketcomponent.MotorMount;
21 import net.sf.openrocket.rocketcomponent.Rocket;
22 import net.sf.openrocket.rocketcomponent.RocketComponent;
23 import net.sf.openrocket.rocketcomponent.TubeCoupler;
24 import net.sf.openrocket.simulation.FlightData;
25 import net.sf.openrocket.simulation.FlightDataBranch;
26 import net.sf.openrocket.simulation.FlightDataType;
27 import net.sf.openrocket.simulation.FlightEvent;
28 import net.sf.openrocket.simulation.SimulationOptions;
29 import net.sf.openrocket.startup.Application;
30 import net.sf.openrocket.util.BugException;
31 import net.sf.openrocket.util.BuildProperties;
32 import net.sf.openrocket.util.MathUtil;
33 import net.sf.openrocket.util.Reflection;
34 import net.sf.openrocket.util.TextUtil;
36 public class OpenRocketSaver extends RocketSaver {
37 private static final LogHelper log = Application.getLogger();
41 * Divisor used in converting an integer version to the point-represented version.
42 * The integer version divided by this value is the major version and the remainder is
43 * the minor version. For example 101 corresponds to file version "1.1".
45 public static final int FILE_VERSION_DIVISOR = 100;
48 private static final String OPENROCKET_CHARSET = "UTF-8";
50 private static final String METHOD_PACKAGE = "net.sf.openrocket.file.openrocket.savers";
51 private static final String METHOD_SUFFIX = "Saver";
54 // Estimated storage used by different portions
55 // These have been hand-estimated from saved files
56 private static final int BYTES_PER_COMPONENT_UNCOMPRESSED = 590;
57 private static final int BYTES_PER_COMPONENT_COMPRESSED = 80;
58 private static final int BYTES_PER_SIMULATION_UNCOMPRESSED = 1000;
59 private static final int BYTES_PER_SIMULATION_COMPRESSED = 100;
60 private static final int BYTES_PER_DATAPOINT_UNCOMPRESSED = 350;
61 private static final int BYTES_PER_DATAPOINT_COMPRESSED = 100;
68 public void save(OutputStream output, OpenRocketDocument document, StorageOptions options)
71 log.info("Saving .ork file");
73 if (options.isCompressionEnabled()) {
74 log.debug("Enabling compression");
75 output = new GZIPOutputStream(output);
78 dest = new BufferedWriter(new OutputStreamWriter(output, OPENROCKET_CHARSET));
80 // Select file version number
81 final int fileVersion = calculateNecessaryFileVersion(document, options);
82 final String fileVersionString =
83 (fileVersion / FILE_VERSION_DIVISOR) + "." + (fileVersion % FILE_VERSION_DIVISOR);
84 log.debug("Storing file version " + fileVersionString);
90 writeln("<?xml version='1.0' encoding='utf-8'?>");
91 writeln("<openrocket version=\"" + fileVersionString + "\" creator=\"OpenRocket "
92 + BuildProperties.getVersion() + "\">");
95 // Recursively save the rocket structure
96 saveComponent(document.getRocket());
100 // Save all simulations
101 writeln("<simulations>");
103 boolean first = true;
104 for (Simulation s : document.getSimulations()) {
108 saveSimulation(s, options.getSimulationTimeSkip());
111 writeln("</simulations>");
114 writeln("</openrocket>");
116 log.debug("Writing complete, flushing buffers");
118 if (options.isCompressionEnabled()) {
119 ((GZIPOutputStream) output).finish();
126 public long estimateFileSize(OpenRocketDocument doc, StorageOptions options) {
130 // Size per component
131 int componentCount = 0;
132 Rocket rocket = doc.getRocket();
133 Iterator<RocketComponent> iterator = rocket.iterator(true);
134 while (iterator.hasNext()) {
139 if (options.isCompressionEnabled())
140 size += componentCount * BYTES_PER_COMPONENT_COMPRESSED;
142 size += componentCount * BYTES_PER_COMPONENT_UNCOMPRESSED;
145 // Size per simulation
146 if (options.isCompressionEnabled())
147 size += doc.getSimulationCount() * BYTES_PER_SIMULATION_COMPRESSED;
149 size += doc.getSimulationCount() * BYTES_PER_SIMULATION_UNCOMPRESSED;
152 // Size per flight data point
154 double timeSkip = options.getSimulationTimeSkip();
155 if (timeSkip != StorageOptions.SIMULATION_DATA_NONE) {
156 for (Simulation s : doc.getSimulations()) {
157 FlightData data = s.getSimulatedData();
159 for (int i = 0; i < data.getBranchCount(); i++) {
160 pointCount += countFlightDataBranchPoints(data.getBranch(i), timeSkip);
166 if (options.isCompressionEnabled())
167 size += pointCount * BYTES_PER_DATAPOINT_COMPRESSED;
169 size += pointCount * BYTES_PER_DATAPOINT_UNCOMPRESSED;
176 * Determine which file version is required in order to store all the features of the
177 * current design. By default the oldest version that supports all the necessary features
180 * @param document the document to output.
181 * @param opts the storage options.
182 * @return the integer file version to use.
184 private int calculateNecessaryFileVersion(OpenRocketDocument document, StorageOptions opts) {
186 * File version 1.2 is required for:
187 * - saving motor data
189 * File version 1.1 is required for:
191 * - components attached to tube coupler
193 * Otherwise use version 1.0.
196 // Check if design has simulations defined (version 1.3)
197 if (document.getSimulationCount() > 0) {
198 return FILE_VERSION_DIVISOR + 3;
201 // Check for motor definitions (version 1.2)
202 Iterator<RocketComponent> iterator = document.getRocket().iterator();
203 while (iterator.hasNext()) {
204 RocketComponent c = iterator.next();
205 if (!(c instanceof MotorMount))
208 MotorMount mount = (MotorMount) c;
209 for (String id : document.getRocket().getMotorConfigurationIDs()) {
210 if (mount.getMotor(id) != null) {
211 return FILE_VERSION_DIVISOR + 2;
216 // Check for fin tabs (version 1.1)
217 iterator = document.getRocket().iterator();
218 while (iterator.hasNext()) {
219 RocketComponent c = iterator.next();
221 // Check for fin tabs
222 if (c instanceof FinSet) {
223 FinSet fin = (FinSet) c;
224 if (!MathUtil.equals(fin.getTabHeight(), 0) &&
225 !MathUtil.equals(fin.getTabLength(), 0)) {
226 return FILE_VERSION_DIVISOR + 1;
230 // Check for components attached to tube coupler
231 if (c instanceof TubeCoupler) {
232 if (c.getChildCount() > 0) {
233 return FILE_VERSION_DIVISOR + 1;
238 // Default (version 1.0)
239 return FILE_VERSION_DIVISOR + 0;
244 @SuppressWarnings("unchecked")
245 private void saveComponent(RocketComponent component) throws IOException {
247 log.debug("Saving component " + component.getComponentName());
249 Reflection.Method m = Reflection.findMethod(METHOD_PACKAGE, component, METHOD_SUFFIX,
250 "getElements", RocketComponent.class);
252 throw new BugException("Unable to find saving class for component " +
253 component.getComponentName());
256 // Get the strings to save
257 List<String> list = (List<String>) m.invokeStatic(component);
258 int length = list.size();
260 if (length == 0) // Nothing to do
264 throw new RuntimeException("BUG, component data length less than two lines.");
268 writeln(list.get(0));
272 for (int i = 1; i < length - 1; i++) {
273 writeln(list.get(i));
276 // Recursively write subcomponents
277 if (component.getChildCount() > 0) {
279 writeln("<subcomponents>");
281 boolean emptyline = false;
282 for (RocketComponent subcomponent : component.getChildren()) {
286 saveComponent(subcomponent);
289 writeln("</subcomponents>");
294 writeln(list.get(length - 1));
298 private void saveSimulation(Simulation simulation, double timeSkip) throws IOException {
299 SimulationOptions cond = simulation.getOptions();
301 writeln("<simulation status=\"" + enumToXMLName(simulation.getStatus()) + "\">");
304 writeln("<name>" + escapeXML(simulation.getName()) + "</name>");
305 // TODO: MEDIUM: Other simulators/calculators
306 writeln("<simulator>RK4Simulator</simulator>");
307 writeln("<calculator>BarrowmanCalculator</calculator>");
308 writeln("<conditions>");
311 writeElement("configid", cond.getMotorConfigurationID());
312 writeElement("launchrodlength", cond.getLaunchRodLength());
313 writeElement("launchrodangle", cond.getLaunchRodAngle() * 180.0 / Math.PI);
314 writeElement("launchroddirection", cond.getLaunchRodDirection() * 180.0 / Math.PI);
315 writeElement("windaverage", cond.getWindSpeedAverage());
316 writeElement("windturbulence", cond.getWindTurbulenceIntensity());
317 writeElement("launchaltitude", cond.getLaunchAltitude());
318 writeElement("launchlatitude", cond.getLaunchLatitude());
319 writeElement("launchlongitude", cond.getLaunchLongitude());
320 writeElement("geodeticmethod", cond.getGeodeticComputation().name().toLowerCase());
322 if (cond.isISAAtmosphere()) {
323 writeln("<atmosphere model=\"isa\"/>");
325 writeln("<atmosphere model=\"extendedisa\">");
327 writeElement("basetemperature", cond.getLaunchTemperature());
328 writeElement("basepressure", cond.getLaunchPressure());
330 writeln("</atmosphere>");
333 writeElement("timestep", cond.getTimeStep());
336 writeln("</conditions>");
339 for (String s : simulation.getSimulationListeners()) {
340 writeElement("listener", escapeXML(s));
344 // Write basic simulation data
346 FlightData data = simulation.getSimulatedData();
348 String str = "<flightdata";
349 if (!Double.isNaN(data.getMaxAltitude()))
350 str += " maxaltitude=\"" + TextUtil.doubleToString(data.getMaxAltitude()) + "\"";
351 if (!Double.isNaN(data.getMaxVelocity()))
352 str += " maxvelocity=\"" + TextUtil.doubleToString(data.getMaxVelocity()) + "\"";
353 if (!Double.isNaN(data.getMaxAcceleration()))
354 str += " maxacceleration=\"" + TextUtil.doubleToString(data.getMaxAcceleration()) + "\"";
355 if (!Double.isNaN(data.getMaxMachNumber()))
356 str += " maxmach=\"" + TextUtil.doubleToString(data.getMaxMachNumber()) + "\"";
357 if (!Double.isNaN(data.getTimeToApogee()))
358 str += " timetoapogee=\"" + TextUtil.doubleToString(data.getTimeToApogee()) + "\"";
359 if (!Double.isNaN(data.getFlightTime()))
360 str += " flighttime=\"" + TextUtil.doubleToString(data.getFlightTime()) + "\"";
361 if (!Double.isNaN(data.getGroundHitVelocity()))
362 str += " groundhitvelocity=\"" + TextUtil.doubleToString(data.getGroundHitVelocity()) + "\"";
363 if (!Double.isNaN(data.getLaunchRodVelocity()))
364 str += " launchrodvelocity=\"" + TextUtil.doubleToString(data.getLaunchRodVelocity()) + "\"";
365 if (!Double.isNaN(data.getDeploymentVelocity()))
366 str += " deploymentvelocity=\"" + TextUtil.doubleToString(data.getDeploymentVelocity()) + "\"";
371 for (Warning w : data.getWarningSet()) {
372 writeElement("warning", escapeXML(w.toString()));
375 // Check whether to store data
376 if (simulation.getStatus() == Simulation.Status.EXTERNAL) // Always store external data
379 if (timeSkip != StorageOptions.SIMULATION_DATA_NONE) {
380 for (int i = 0; i < data.getBranchCount(); i++) {
381 FlightDataBranch branch = data.getBranch(i);
382 saveFlightDataBranch(branch, timeSkip);
387 writeln("</flightdata>");
391 writeln("</simulation>");
397 private void saveFlightDataBranch(FlightDataBranch branch, double timeSkip)
399 double previousTime = -100000;
404 // Retrieve the types from the branch
405 FlightDataType[] types = branch.getTypes();
407 if (types.length == 0)
410 // Retrieve the data from the branch
411 List<List<Double>> data = new ArrayList<List<Double>>(types.length);
412 for (int i = 0; i < types.length; i++) {
413 data.add(branch.get(types[i]));
415 List<Double> timeData = branch.get(FlightDataType.TYPE_TIME);
417 // Build the <databranch> tag
418 StringBuilder sb = new StringBuilder();
419 sb.append("<databranch name=\"");
420 sb.append(escapeXML(branch.getBranchName()));
421 sb.append("\" types=\"");
422 for (int i = 0; i < types.length; i++) {
425 sb.append(escapeXML(types[i].getName()));
428 writeln(sb.toString());
432 for (FlightEvent event : branch.getEvents()) {
433 writeln("<event time=\"" + TextUtil.doubleToString(event.getTime())
434 + "\" type=\"" + enumToXMLName(event.getType()) + "\"/>");
438 int length = branch.getLength();
440 writeDataPointString(data, 0, sb);
441 previousTime = timeData.get(0);
444 for (int i = 1; i < length - 1; i++) {
445 if (timeData != null) {
446 if (Math.abs(timeData.get(i) - previousTime - timeSkip) < Math.abs(timeData.get(i + 1) - previousTime - timeSkip)) {
447 writeDataPointString(data, i, sb);
448 previousTime = timeData.get(i);
451 // If time data is not available, write all points
452 writeDataPointString(data, i, sb);
457 writeDataPointString(data, length - 1, sb);
461 writeln("</databranch>");
466 /* TODO: LOW: This is largely duplicated from above! */
467 private int countFlightDataBranchPoints(FlightDataBranch branch, double timeSkip) {
470 double previousTime = -100000;
475 // Retrieve the types from the branch
476 FlightDataType[] types = branch.getTypes();
478 if (types.length == 0)
481 List<Double> timeData = branch.get(FlightDataType.TYPE_TIME);
482 if (timeData == null) {
483 // If time data not available, store all points
484 return branch.getLength();
488 int length = branch.getLength();
491 previousTime = timeData.get(0);
494 for (int i = 1; i < length - 1; i++) {
495 if (Math.abs(timeData.get(i) - previousTime - timeSkip) < Math.abs(timeData.get(i + 1) - previousTime - timeSkip)) {
497 previousTime = timeData.get(i);
510 private void writeDataPointString(List<List<Double>> data, int index, StringBuilder sb)
513 sb.append("<datapoint>");
514 for (int j = 0; j < data.size(); j++) {
517 sb.append(TextUtil.doubleToString(data.get(j).get(index)));
519 sb.append("</datapoint>");
520 writeln(sb.toString());
525 private void writeElement(String element, Object content) throws IOException {
528 writeln("<" + element + ">" + content + "</" + element + ">");
533 private void writeln(String str) throws IOException {
534 if (str.length() == 0) {
539 for (int i = 0; i < indent; i++)
549 * Return the XML equivalent of an enum name.
551 * @param e the enum to save.
552 * @return the corresponding XML name.
554 public static String enumToXMLName(Enum<?> e) {
555 return e.name().toLowerCase().replace("_", "");