Rework the CustomExpression evaluation to use SimulationListeners. Removed the OpenRocketDocument member variable from the Simulation object.

This commit is contained in:
Kevin Ruland 2012-08-08 02:24:40 +00:00
parent 2b802c2f7d
commit a5c3c1ac76
17 changed files with 232 additions and 211 deletions

View File

@ -75,8 +75,7 @@ public class CurrentRocket {
public synchronized void addNewSimulation( Context context ) {
isModified = true;
Rocket rocket = rocketDocument.getRocket();
// FIXME - hopefully the change to the Simulation object will be reverted soon.
Simulation newSim = new Simulation(rocketDocument, rocket);
Simulation newSim = new Simulation(rocket);
newSim.setName(rocketDocument.getNextSimulationName());
rocketDocument.addSimulation(newSim);
notifySimsChanged(context);

View File

@ -117,7 +117,7 @@ public class OpenRocketDocument implements ComponentChangeListener {
customExpressions.remove(expression);
}
public ArrayList<CustomExpression> getCustomExpressions(){
public List<CustomExpression> getCustomExpressions(){
return customExpressions;
}

View File

@ -60,7 +60,6 @@ public class Simulation implements ChangeSource, Cloneable {
private SafetyMutex mutex = SafetyMutex.newInstance();
private final Rocket rocket;
private final OpenRocketDocument document;
private String name = "";
@ -94,11 +93,7 @@ public class Simulation implements ChangeSource, Cloneable {
*
* @param rocket the rocket associated with the simulation.
*/
public Simulation(OpenRocketDocument doc, Rocket rocket) {
// It may seem silly to pass in the document and rocket, since usually when called we
// use doc.getRocket, but I guess there is some reason; when cloning a simulation + rocket we don't need
// to make a duplicate of the undo data etc stored in the document. --Richard
this.document = doc;
public Simulation(Rocket rocket) {
this.rocket = rocket;
this.status = Status.NOT_SIMULATED;
@ -109,7 +104,7 @@ public class Simulation implements ChangeSource, Cloneable {
}
public Simulation(OpenRocketDocument doc, Rocket rocket, Status status, String name, SimulationOptions options,
public Simulation(Rocket rocket, Status status, String name, SimulationOptions options,
List<String> listeners, FlightData data) {
if (rocket == null)
@ -122,7 +117,6 @@ public class Simulation implements ChangeSource, Cloneable {
throw new IllegalArgumentException("options cannot be null");
this.rocket = rocket;
this.document = doc;
if (status == Status.UPTODATE) {
this.status = Status.LOADED;
@ -152,13 +146,6 @@ public class Simulation implements ChangeSource, Cloneable {
}
/*
* Return the parent document for this simulation
*/
public OpenRocketDocument getDocument(){
return document;
}
/**
* Return the rocket associated with this simulation.
*
@ -423,7 +410,7 @@ public class Simulation implements ChangeSource, Cloneable {
public Simulation duplicateSimulation(Rocket newRocket) {
mutex.lock("duplicateSimulation");
try {
Simulation copy = new Simulation(document, newRocket);
Simulation copy = new Simulation(newRocket);
copy.name = this.name;
copy.options.copyFrom(this.options);

View File

@ -1383,7 +1383,7 @@ class SingleSimulationHandler extends AbstractElementHandler {
else
data = dataHandler.getFlightData();
Simulation simulation = new Simulation(doc, doc.getRocket(), status, name,
Simulation simulation = new Simulation(doc.getRocket(), status, name,
conditions, listeners, data);
doc.addSimulation(simulation);

View File

@ -5,8 +5,8 @@ import java.awt.Window;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import javax.swing.BorderFactory;
import javax.swing.JButton;
@ -17,23 +17,17 @@ import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.SwingUtilities;
import javax.swing.border.Border;
import javax.swing.filechooser.FileFilter;
import javax.swing.filechooser.FileNameExtensionFilter;
import net.miginfocom.swing.MigLayout;
import net.sf.openrocket.document.OpenRocketDocument;
import net.sf.openrocket.file.DatabaseMotorFinder;
import net.sf.openrocket.file.GeneralRocketLoader;
import net.sf.openrocket.file.MotorFinder;
import net.sf.openrocket.file.RocketLoadException;
import net.sf.openrocket.document.Simulation;
import net.sf.openrocket.gui.components.DescriptionArea;
import net.sf.openrocket.gui.components.UnitSelector;
import net.sf.openrocket.gui.customexpression.ExpressionBuilderDialog;
import net.sf.openrocket.gui.util.Icons;
import net.sf.openrocket.l10n.Translator;
import net.sf.openrocket.logging.LogHelper;
import net.sf.openrocket.rocketcomponent.Rocket;
import net.sf.openrocket.simulation.customexpression.CustomExpression;
import net.sf.openrocket.startup.Application;
@ -158,7 +152,7 @@ public class CustomExpressionPanel extends JPanel {
* @param move integer - +1 to move down, -1 to move up
*/
private void moveExpression(CustomExpression expression, int move){
ArrayList<CustomExpression> expressions = doc.getCustomExpressions();
List<CustomExpression> expressions = doc.getCustomExpressions();
int i = expressions.indexOf(expression);
if (i+move == expressions.size() || i+move < 0)
return;

View File

@ -1000,14 +1000,14 @@ public class GeneralOptimizationDialog extends JDialog {
if (id == null) {
continue;
}
Simulation sim = new Simulation(documentCopy, rocket);
Simulation sim = new Simulation(rocket);
sim.getConfiguration().setMotorConfigurationID(id);
String name = createSimulationName(trans.get("basicSimulationName"), rocket.getMotorConfigurationNameOrDescription(id));
simulations.add(new Named<Simulation>(sim, name));
}
Simulation sim = new Simulation(documentCopy, rocket);
Simulation sim = new Simulation(rocket);
sim.getConfiguration().setMotorConfigurationID(null);
String name = createSimulationName(trans.get("noSimulationName"), rocket.getMotorConfigurationNameOrDescription(null));
simulations.add(new Named<Simulation>(sim, name));

View File

@ -30,6 +30,7 @@ import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import net.miginfocom.swing.MigLayout;
import net.sf.openrocket.document.OpenRocketDocument;
import net.sf.openrocket.document.Simulation;
import net.sf.openrocket.gui.SpinnerEditor;
import net.sf.openrocket.gui.adaptors.BooleanModel;
@ -41,7 +42,6 @@ import net.sf.openrocket.gui.components.DescriptionArea;
import net.sf.openrocket.gui.components.SimulationExportPanel;
import net.sf.openrocket.gui.components.UnitSelector;
import net.sf.openrocket.gui.plot.Axis;
import net.sf.openrocket.gui.customexpression.CustomExpressionPanel;
import net.sf.openrocket.gui.plot.PlotConfiguration;
import net.sf.openrocket.gui.plot.SimulationPlotPanel;
import net.sf.openrocket.gui.util.GUIUtil;
@ -83,19 +83,20 @@ public class SimulationEditDialog extends JDialog {
private final Window parentWindow;
private final Simulation simulation;
private final OpenRocketDocument document;
private final SimulationOptions conditions;
private final Configuration configuration;
private static final Translator trans = Application.getTranslator();
public SimulationEditDialog(Window parent, Simulation s) {
this(parent, s, 0);
public SimulationEditDialog(Window parent, OpenRocketDocument document, Simulation s) {
this(parent, document, s, 0);
}
public SimulationEditDialog(Window parent, Simulation s, int tab) {
public SimulationEditDialog(Window parent, OpenRocketDocument document, Simulation s, int tab) {
//// Edit simulation
super(parent, trans.get("simedtdlg.title.Editsim"), JDialog.ModalityType.DOCUMENT_MODAL);
this.document = document;
this.parentWindow = parent;
this.simulation = s;
this.conditions = simulation.getOptions();
@ -170,7 +171,7 @@ public class SimulationEditDialog extends JDialog {
@Override
public void actionPerformed(ActionEvent e) {
SimulationEditDialog.this.dispose();
SimulationRunDialog.runSimulations(parentWindow, simulation);
SimulationRunDialog.runSimulations(parentWindow, SimulationEditDialog.this.document, simulation);
}
});
mainPanel.add(button, "gapright para");

View File

@ -82,7 +82,7 @@ public class SimulationPanel extends JPanel {
button.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
Simulation sim = new Simulation(document, document.getRocket());
Simulation sim = new Simulation(document.getRocket());
sim.setName(document.getNextSimulationName());
int n = document.getSimulationCount();
@ -135,7 +135,7 @@ public class SimulationPanel extends JPanel {
long t = System.currentTimeMillis();
new SimulationRunDialog(SwingUtilities.getWindowAncestor(
SimulationPanel.this), sims).setVisible(true);
SimulationPanel.this), document, sims).setVisible(true);
log.info("Running simulations took " + (System.currentTimeMillis() - t) + " ms");
fireMaintainSelection();
}
@ -514,7 +514,7 @@ public class SimulationPanel extends JPanel {
}
private void openDialog(final Simulation sim, int position) {
new SimulationEditDialog(SwingUtilities.getWindowAncestor(this), sim, position)
new SimulationEditDialog(SwingUtilities.getWindowAncestor(this), document, sim, position)
.setVisible(true);
fireMaintainSelection();
}

View File

@ -24,6 +24,7 @@ import javax.swing.JPanel;
import javax.swing.JProgressBar;
import net.miginfocom.swing.MigLayout;
import net.sf.openrocket.document.OpenRocketDocument;
import net.sf.openrocket.document.Simulation;
import net.sf.openrocket.gui.dialogs.DetailDialog;
import net.sf.openrocket.gui.util.GUIUtil;
@ -35,6 +36,8 @@ import net.sf.openrocket.rocketcomponent.MotorMount;
import net.sf.openrocket.rocketcomponent.MotorMount.IgnitionEvent;
import net.sf.openrocket.simulation.FlightEvent;
import net.sf.openrocket.simulation.SimulationStatus;
import net.sf.openrocket.simulation.customexpression.CustomExpression;
import net.sf.openrocket.simulation.customexpression.CustomExpressionSimulationListener;
import net.sf.openrocket.simulation.exception.SimulationCancelledException;
import net.sf.openrocket.simulation.exception.SimulationException;
import net.sf.openrocket.simulation.exception.SimulationLaunchException;
@ -95,6 +98,7 @@ public class SimulationRunDialog extends JDialog {
* will result in an exception being thrown!
*/
private final Simulation[] simulations;
private final OpenRocketDocument document;
private final String[] simulationNames;
private final SimulationWorker[] simulationWorkers;
private final SimulationStatus[] simulationStatuses;
@ -102,9 +106,10 @@ public class SimulationRunDialog extends JDialog {
private final double[] simulationMaxVelocity;
private final boolean[] simulationDone;
public SimulationRunDialog(Window window, Simulation... simulations) {
public SimulationRunDialog(Window window, OpenRocketDocument document, Simulation... simulations) {
//// Running simulations...
super(window, trans.get("SimuRunDlg.title.RunSim"), Dialog.ModalityType.APPLICATION_MODAL);
this.document = document;
if (simulations.length == 0) {
throw new IllegalArgumentException("Called with no simulations to run");
@ -129,7 +134,7 @@ public class SimulationRunDialog extends JDialog {
for (int i = 0; i < n; i++) {
simulationNames[i] = simulations[i].getName();
simulationWorkers[i] = new InteractiveSimulationWorker(simulations[i], i);
simulationWorkers[i] = new InteractiveSimulationWorker(document, simulations[i], i);
executor.execute(simulationWorkers[i]);
}
@ -208,8 +213,8 @@ public class SimulationRunDialog extends JDialog {
* @param parent the parent Window of the dialog to use.
* @param simulations the simulations to run.
*/
public static void runSimulations(Window parent, Simulation... simulations) {
new SimulationRunDialog(parent, simulations).setVisible(true);
public static void runSimulations(Window parent, OpenRocketDocument document, Simulation... simulations) {
new SimulationRunDialog(parent, document, simulations).setVisible(true);
}
@ -277,6 +282,8 @@ public class SimulationRunDialog extends JDialog {
private volatile double burnoutVelocity;
private volatile double apogeeAltitude;
private final CustomExpressionSimulationListener exprListener;
/*
* -2 = time from 0 ... burnoutTimeEstimate
* -1 = velocity from v(burnoutTimeEstimate) ... 0
@ -287,8 +294,10 @@ public class SimulationRunDialog extends JDialog {
private int progress = 0;
public InteractiveSimulationWorker(Simulation sim, int index) {
public InteractiveSimulationWorker(OpenRocketDocument doc, Simulation sim, int index) {
super(sim);
List<CustomExpression> exprs = doc.getCustomExpressions();
exprListener = new CustomExpressionSimulationListener(exprs);
this.index = index;
// Calculate estimate of motor burn time
@ -314,7 +323,7 @@ public class SimulationRunDialog extends JDialog {
*/
@Override
protected SimulationListener[] getExtraListeners() {
return new SimulationListener[] { new SimulationProgressListener() };
return new SimulationListener[] { new SimulationProgressListener(), exprListener };
}

View File

@ -62,6 +62,8 @@ import net.sf.openrocket.rocketcomponent.Rocket;
import net.sf.openrocket.rocketcomponent.RocketComponent;
import net.sf.openrocket.rocketcomponent.SymmetricComponent;
import net.sf.openrocket.simulation.FlightData;
import net.sf.openrocket.simulation.customexpression.CustomExpression;
import net.sf.openrocket.simulation.customexpression.CustomExpressionSimulationListener;
import net.sf.openrocket.simulation.listeners.SimulationListener;
import net.sf.openrocket.simulation.listeners.system.ApogeeEndListener;
import net.sf.openrocket.simulation.listeners.system.InterruptListener;
@ -693,7 +695,7 @@ public class RocketPanel extends JPanel implements TreeSelectionListener, Change
simulation.getOptions().setMotorConfigurationID(
configuration.getMotorConfigurationID());
backgroundSimulationWorker = new BackgroundSimulationWorker(simulation);
backgroundSimulationWorker = new BackgroundSimulationWorker(document, simulation);
backgroundSimulationExecutor.execute(backgroundSimulationWorker);
}
@ -715,8 +717,12 @@ public class RocketPanel extends JPanel implements TreeSelectionListener, Change
*/
private class BackgroundSimulationWorker extends SimulationWorker {
public BackgroundSimulationWorker(Simulation sim) {
private final CustomExpressionSimulationListener exprListener;
public BackgroundSimulationWorker(OpenRocketDocument doc, Simulation sim) {
super(sim);
List<CustomExpression> exprs = doc.getCustomExpressions();
exprListener = new CustomExpressionSimulationListener(exprs);
}
@Override
@ -750,7 +756,9 @@ public class RocketPanel extends JPanel implements TreeSelectionListener, Change
protected SimulationListener[] getExtraListeners() {
return new SimulationListener[] {
InterruptListener.INSTANCE,
ApogeeEndListener.INSTANCE };
ApogeeEndListener.INSTANCE,
exprListener};
}
@Override

View File

@ -15,7 +15,6 @@ import java.util.prefs.BackingStoreException;
import java.util.prefs.Preferences;
import net.sf.openrocket.arch.SystemInfo;
import net.sf.openrocket.document.OpenRocketDocument;
import net.sf.openrocket.document.Simulation;
import net.sf.openrocket.logging.LogHelper;
import net.sf.openrocket.material.Material;
@ -399,7 +398,7 @@ public class SwingPreferences extends net.sf.openrocket.startup.Preferences {
}
public Simulation getBackgroundSimulation(Rocket rocket) {
Simulation s = new Simulation(new OpenRocketDocument(rocket), rocket);
Simulation s = new Simulation(rocket);
SimulationOptions cond = s.getOptions();
cond.setTimeStep(RK4SimulationStepper.RECOMMENDED_TIME_STEP * 2);

View File

@ -126,7 +126,7 @@ public class DefaultSimulationModifierService implements SimulationModifierServi
Rocket rocket = document.getRocket();
// Simulation is used to calculate default min/max values
Simulation simulation = new Simulation(document, rocket);
Simulation simulation = new Simulation(rocket);
simulation.getConfiguration().setMotorConfigurationID(null);
for (RocketComponent c : rocket) {

View File

@ -90,12 +90,6 @@ public class BasicEventSimulationEngine implements SimulationEngine {
}
SimulationListenerHelper.firePostStep(status);
// Calculate values for custom expressions
FlightDataBranch data = status.getFlightData();
ArrayList<CustomExpression> allExpressions = status.getSimulationConditions().getSimulation().getDocument().getCustomExpressions();
for (CustomExpression expression : allExpressions ) {
data.setValue(expression.getType(), expression.evaluateDouble(status));
}
// Check for NaN values in the simulation status
checkNaN();

View File

@ -175,7 +175,7 @@ public class CustomExpression implements Cloneable{
names.add(type.getName());
if (doc != null){
ArrayList<CustomExpression> expressions = doc.getCustomExpressions();
List<CustomExpression> expressions = doc.getCustomExpressions();
for (CustomExpression exp : expressions ){
if (exp != this)
names.add(exp.getName());
@ -412,7 +412,7 @@ public class CustomExpression implements Cloneable{
*/
public void addToDocument(){
// Abort if exact expression already in
ArrayList<CustomExpression> expressions = doc.getCustomExpressions();
List<CustomExpression> expressions = doc.getCustomExpressions();
if ( !expressions.isEmpty() ) {
// check if expression already exists
if ( expressions.contains(this) ){

View File

@ -0,0 +1,34 @@
package net.sf.openrocket.simulation.customexpression;
import java.util.ArrayList;
import java.util.List;
import net.sf.openrocket.simulation.FlightDataBranch;
import net.sf.openrocket.simulation.SimulationStatus;
import net.sf.openrocket.simulation.exception.SimulationException;
import net.sf.openrocket.simulation.listeners.AbstractSimulationListener;
public class CustomExpressionSimulationListener extends AbstractSimulationListener {
private final List<CustomExpression> expressions;
public CustomExpressionSimulationListener(List<CustomExpression> expressions) {
super();
this.expressions = expressions;
}
@Override
public void postStep(SimulationStatus status) throws SimulationException {
if ( expressions == null || expressions.size() == 0 ) {
return;
}
// Calculate values for custom expressions
FlightDataBranch data = status.getFlightData();
for (CustomExpression expression : expressions ) {
data.setValue(expression.getType(), expression.evaluateDouble(status));
}
}
}

View File

@ -1,7 +1,6 @@
package net.sf.openrocket.optimization.rocketoptimization;
import static org.junit.Assert.*;
import net.sf.openrocket.document.OpenRocketDocument;
import net.sf.openrocket.document.Simulation;
import net.sf.openrocket.optimization.general.OptimizationException;
import net.sf.openrocket.optimization.general.Point;
@ -40,7 +39,7 @@ public class TestRocketOptimizationFunction {
@Test
public void testNormalEvaluation() throws InterruptedException, OptimizationException {
final Rocket rocket = new Rocket();
final Simulation simulation = new Simulation(new OpenRocketDocument(rocket), rocket);
final Simulation simulation = new Simulation(rocket);
final double p1 = 0.4;
final double p2 = 0.7;
@ -86,7 +85,7 @@ public class TestRocketOptimizationFunction {
@Test
public void testNaNValue() throws InterruptedException, OptimizationException {
final Rocket rocket = new Rocket();
final Simulation simulation = new Simulation(new OpenRocketDocument(rocket), rocket);
final Simulation simulation = new Simulation(rocket);
final double p1 = 0.4;
final double p2 = 0.7;
@ -123,7 +122,7 @@ public class TestRocketOptimizationFunction {
@Test
public void testOutsideDomain() throws InterruptedException, OptimizationException {
final Rocket rocket = new Rocket();
final Simulation simulation = new Simulation(new OpenRocketDocument(rocket), rocket);
final Simulation simulation = new Simulation(rocket);
final double p1 = 0.4;
final double p2 = 0.7;
@ -164,7 +163,7 @@ public class TestRocketOptimizationFunction {
@Test
public void testOutsideDomain2() throws InterruptedException, OptimizationException {
final Rocket rocket = new Rocket();
final Simulation simulation = new Simulation(new OpenRocketDocument(rocket), rocket);
final Simulation simulation = new Simulation(rocket);
final double p1 = 0.4;
final double p2 = 0.7;
@ -197,7 +196,7 @@ public class TestRocketOptimizationFunction {
public void testNewSimulationInstance() {
final Rocket rocket = new Rocket();
rocket.setName("Foobar");
final Simulation simulation = new Simulation(new OpenRocketDocument(rocket), rocket);
final Simulation simulation = new Simulation(rocket);
simulation.setName("MySim");
RocketOptimizationFunction function = new RocketOptimizationFunction(simulation,

View File

@ -2,7 +2,6 @@ package net.sf.openrocket.optimization.rocketoptimization.modifiers;
import static net.sf.openrocket.util.MathUtil.EPSILON;
import static org.junit.Assert.assertEquals;
import net.sf.openrocket.document.OpenRocketDocument;
import net.sf.openrocket.document.Simulation;
import net.sf.openrocket.optimization.general.OptimizationException;
import net.sf.openrocket.rocketcomponent.Rocket;
@ -21,9 +20,7 @@ public class TestGenericModifier {
@Before
public void setup() {
value = new TestValue();
Rocket rocket = new Rocket();
sim = new Simulation(new OpenRocketDocument(rocket), rocket);
sim = new Simulation(new Rocket());
Object related = new Object();