Save component ID for component + save flight event source

This is to fix an issue where simulations loaded from the .ork file did not have the correct event source set
CHarris0812 · Jun 27, 2023 · bc8f72c · bc8f72c
1 parent 16893a7
commit bc8f72c
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 5 deletions.
diff --git a/core/src/net/sf/openrocket/file/openrocket/OpenRocketSaver.java b/core/src/net/sf/openrocket/file/openrocket/OpenRocketSaver.java
@@ -531,8 +531,13 @@ private void saveFlightDataBranch(FlightDataBranch branch)
 
 		// Write events
 		for (FlightEvent event : branch.getEvents()) {
-			writeln("<event time=\"" + TextUtil.doubleToString(event.getTime())
-					+ "\" type=\"" + enumToXMLName(event.getType()) + "\"/>");
+			String eventStr = "<event time=\"" + TextUtil.doubleToString(event.getTime())
+					+ "\" type=\"" + enumToXMLName(event.getType());
+			if (event.getSource() != null) {
+				eventStr += "\" source=\"" + TextUtil.escapeXML(event.getSource().getID());
+			}
+			eventStr += "\"/>";
+			writeln(eventStr);
 		}
 
 		// Write the data

diff --git a/core/src/net/sf/openrocket/file/openrocket/importt/DocumentConfig.java b/core/src/net/sf/openrocket/file/openrocket/importt/DocumentConfig.java
@@ -113,6 +113,8 @@ class DocumentConfig {
 		// RocketComponent
 		setters.put("RocketComponent:name", new StringSetter(
 				Reflection.findMethod(RocketComponent.class, "setName", String.class)));
+		setters.put("RocketComponent:id", new StringSetter(
+				Reflection.findMethod(RocketComponent.class, "setID", String.class)));
 		setters.put("RocketComponent:color", new ColorSetter(
 				Reflection.findMethod(RocketComponent.class, "setColor", Color.class)));
 		setters.put("RocketComponent:linestyle", new EnumSetter<LineStyle>(

diff --git a/core/src/net/sf/openrocket/file/openrocket/importt/FlightDataBranchHandler.java b/core/src/net/sf/openrocket/file/openrocket/importt/FlightDataBranchHandler.java
@@ -8,6 +8,8 @@
 import net.sf.openrocket.file.simplesax.ElementHandler;
 import net.sf.openrocket.file.simplesax.PlainTextHandler;
 import net.sf.openrocket.l10n.Translator;
+import net.sf.openrocket.rocketcomponent.Rocket;
+import net.sf.openrocket.rocketcomponent.RocketComponent;
 import net.sf.openrocket.simulation.FlightDataBranch;
 import net.sf.openrocket.simulation.FlightDataType;
 import net.sf.openrocket.simulation.FlightEvent;
@@ -126,6 +128,8 @@ public void closeElement(String element, HashMap<String, String> attributes,
 		if (element.equals("event")) {
 			double time;
 			FlightEvent.Type type;
+			String sourceID;
+			RocketComponent source = null;
 
 			try {
 				time = DocumentConfig.stringToDouble(attributes.get("time"));
@@ -139,8 +143,20 @@ public void closeElement(String element, HashMap<String, String> attributes,
 				warnings.add("Illegal event specification, ignoring.");
 				return;
 			}
+
+			// Get the event source
+			Rocket rocket = context.getOpenRocketDocument().getRocket();
+			sourceID = attributes.get("source");
+			if (sourceID != null) {
+				for (RocketComponent child : rocket.getAllChildren()) {
+					if (child.getID().equals(sourceID)) {
+						source = child;
+						break;
+					}
+				}
+			}
 
-			branch.addEvent(new FlightEvent(type, time));
+			branch.addEvent(new FlightEvent(type, time, source));
 			return;
 		}
 

diff --git a/core/src/net/sf/openrocket/file/openrocket/savers/RocketComponentSaver.java b/core/src/net/sf/openrocket/file/openrocket/savers/RocketComponentSaver.java
@@ -36,6 +36,7 @@ protected RocketComponentSaver() {
 
 	protected void addParams(net.sf.openrocket.rocketcomponent.RocketComponent c, List<String> elements) {
 		elements.add("<name>" + TextUtil.escapeXML(c.getName()) + "</name>");
+		elements.add("<id>" + TextUtil.escapeXML(c.getID()) + "</id>");
 
 		ComponentPreset preset = c.getPresetComponent();
 		if (preset != null) {

diff --git a/core/src/net/sf/openrocket/rocketcomponent/RocketComponent.java b/core/src/net/sf/openrocket/rocketcomponent/RocketComponent.java
@@ -1206,8 +1206,16 @@ private final void newID() {
 		mutex.verify();
 		this.id = UniqueID.uuid();
 	}
-
-
+
+	/**
+	 * Set the ID for this component.
+	 * Generally not recommended to directly set the ID, this is done automatically. Only use this in case you have to.
+	 * @param newID new ID
+	 */
+	public void setID(String newID) {
+		mutex.verify();
+		this.id = newID;
+	}
 
 
 	/**

diff --git a/fileformat.txt b/fileformat.txt
@@ -63,3 +63,6 @@ The following file format versions exist:
       Rename <fincount> to <instancecount> (<fincount> remains for backward compatibility)
       Rename <position> to <axialoffset> (<position> remains for backward compatibility)
       Rename <rotation> to <angleoffset> (<rotation> remains for backward compatibility)
+
+1.9:  Introduced with OpenRocket 23.xx.
+      Added ID for each rocket component, to in turn add this ID as a source for flight events.