optimization updates
[debian/openrocket] / src / net / sf / openrocket / gui / dialogs / optimization / GeneralOptimizationDialog.java
1 package net.sf.openrocket.gui.dialogs.optimization;
2
3 import java.awt.Component;
4 import java.awt.Window;
5 import java.awt.event.ActionEvent;
6 import java.awt.event.ActionListener;
7 import java.awt.event.MouseAdapter;
8 import java.awt.event.MouseEvent;
9 import java.io.BufferedWriter;
10 import java.io.File;
11 import java.io.FileWriter;
12 import java.io.IOException;
13 import java.io.Writer;
14 import java.text.Collator;
15 import java.util.ArrayList;
16 import java.util.Collections;
17 import java.util.Comparator;
18 import java.util.HashMap;
19 import java.util.LinkedHashMap;
20 import java.util.LinkedList;
21 import java.util.List;
22 import java.util.Map;
23
24 import javax.swing.BorderFactory;
25 import javax.swing.DefaultComboBoxModel;
26 import javax.swing.JButton;
27 import javax.swing.JCheckBox;
28 import javax.swing.JComboBox;
29 import javax.swing.JComponent;
30 import javax.swing.JDialog;
31 import javax.swing.JFileChooser;
32 import javax.swing.JLabel;
33 import javax.swing.JOptionPane;
34 import javax.swing.JPanel;
35 import javax.swing.JScrollPane;
36 import javax.swing.JSpinner;
37 import javax.swing.JTable;
38 import javax.swing.JToggleButton;
39 import javax.swing.ListSelectionModel;
40 import javax.swing.border.TitledBorder;
41 import javax.swing.event.ChangeEvent;
42 import javax.swing.event.ChangeListener;
43 import javax.swing.event.ListSelectionEvent;
44 import javax.swing.event.ListSelectionListener;
45 import javax.swing.event.TreeSelectionEvent;
46 import javax.swing.event.TreeSelectionListener;
47 import javax.swing.table.AbstractTableModel;
48 import javax.swing.table.DefaultTableCellRenderer;
49 import javax.swing.table.TableColumnModel;
50 import javax.swing.tree.DefaultMutableTreeNode;
51 import javax.swing.tree.TreePath;
52
53 import net.miginfocom.swing.MigLayout;
54 import net.sf.openrocket.document.OpenRocketDocument;
55 import net.sf.openrocket.document.Simulation;
56 import net.sf.openrocket.gui.SpinnerEditor;
57 import net.sf.openrocket.gui.adaptors.DoubleModel;
58 import net.sf.openrocket.gui.components.CsvOptionPanel;
59 import net.sf.openrocket.gui.components.DescriptionArea;
60 import net.sf.openrocket.gui.components.DoubleCellEditor;
61 import net.sf.openrocket.gui.components.StyledLabel;
62 import net.sf.openrocket.gui.components.StyledLabel.Style;
63 import net.sf.openrocket.gui.components.UnitCellEditor;
64 import net.sf.openrocket.gui.components.UnitSelector;
65 import net.sf.openrocket.gui.scalefigure.RocketFigure;
66 import net.sf.openrocket.gui.scalefigure.ScaleScrollPane;
67 import net.sf.openrocket.l10n.Translator;
68 import net.sf.openrocket.logging.LogHelper;
69 import net.sf.openrocket.optimization.general.OptimizationException;
70 import net.sf.openrocket.optimization.general.Point;
71 import net.sf.openrocket.optimization.rocketoptimization.OptimizableParameter;
72 import net.sf.openrocket.optimization.rocketoptimization.OptimizationGoal;
73 import net.sf.openrocket.optimization.rocketoptimization.SimulationDomain;
74 import net.sf.openrocket.optimization.rocketoptimization.SimulationModifier;
75 import net.sf.openrocket.optimization.rocketoptimization.domains.IdentitySimulationDomain;
76 import net.sf.openrocket.optimization.rocketoptimization.domains.StabilityDomain;
77 import net.sf.openrocket.optimization.rocketoptimization.goals.MaximizationGoal;
78 import net.sf.openrocket.optimization.rocketoptimization.goals.MinimizationGoal;
79 import net.sf.openrocket.optimization.rocketoptimization.goals.ValueSeekGoal;
80 import net.sf.openrocket.optimization.services.OptimizationServiceHelper;
81 import net.sf.openrocket.rocketcomponent.Rocket;
82 import net.sf.openrocket.rocketcomponent.RocketComponent;
83 import net.sf.openrocket.startup.Application;
84 import net.sf.openrocket.unit.CaliberUnit;
85 import net.sf.openrocket.unit.Unit;
86 import net.sf.openrocket.unit.UnitGroup;
87 import net.sf.openrocket.unit.Value;
88 import net.sf.openrocket.util.BugException;
89 import net.sf.openrocket.util.Chars;
90 import net.sf.openrocket.util.FileHelper;
91 import net.sf.openrocket.util.GUIUtil;
92 import net.sf.openrocket.util.Named;
93 import net.sf.openrocket.util.Prefs;
94 import net.sf.openrocket.util.TextUtil;
95
96 import com.itextpdf.text.Font;
97
98 // FIXME: Override to zero mass produces NaN in simulation
99
100 /**
101  * General rocket optimization dialog.
102  * 
103  * @author Sampo Niskanen <sampo.niskanen@iki.fi>
104  */
105 public class GeneralOptimizationDialog extends JDialog {
106         private static final LogHelper log = Application.getLogger();
107         private static final Translator trans = Application.getTranslator();
108         
109         private static final Collator collator = Collator.getInstance();
110         
111
112         private static final String GOAL_MAXIMIZE = trans.get("goal.maximize");
113         private static final String GOAL_MINIMIZE = trans.get("goal.minimize");
114         private static final String GOAL_SEEK = trans.get("goal.seek");
115         
116         private static final String START_TEXT = trans.get("btn.start");
117         private static final String STOP_TEXT = trans.get("btn.stop");
118         
119
120
121         private final List<OptimizableParameter> optimizationParameters = new ArrayList<OptimizableParameter>();
122         private final Map<Object, List<SimulationModifier>> simulationModifiers =
123                         new HashMap<Object, List<SimulationModifier>>();
124         
125
126         private final OpenRocketDocument baseDocument;
127         private OpenRocketDocument documentCopy;
128         
129
130         private final JButton addButton;
131         private final JButton removeButton;
132         private final JButton removeAllButton;
133         
134         private final ParameterSelectionTableModel selectedModifierTableModel;
135         private final JTable selectedModifierTable;
136         private final DescriptionArea selectedModifierDescription;
137         private final SimulationModifierTree availableModifierTree;
138         
139         private final JComboBox simulationSelectionCombo;
140         private final JComboBox optimizationParameterCombo;
141         
142         private final JComboBox optimizationGoalCombo;
143         private final JSpinner optimizationGoalSpinner;
144         private final UnitSelector optimizationGoalUnitSelector;
145         private final DoubleModel optimizationSeekValue;
146         
147         private DoubleModel minimumStability;
148         private DoubleModel maximumStability;
149         private final JCheckBox minimumStabilitySelected;
150         private final JSpinner minimumStabilitySpinner;
151         private final UnitSelector minimumStabilityUnitSelector;
152         private final JCheckBox maximumStabilitySelected;
153         private final JSpinner maximumStabilitySpinner;
154         private final UnitSelector maximumStabilityUnitSelector;
155         
156         private final JLabel bestValueLabel;
157         private final JLabel stepCountLabel;
158         private final JLabel evaluationCountLabel;
159         private final JLabel stepSizeLabel;
160         
161         private final RocketFigure figure;
162         private final JToggleButton startButton;
163         private final JButton plotButton;
164         private final JButton saveButton;
165         
166         private final JButton applyButton;
167         private final JButton resetButton;
168         private final JButton closeButton;
169         
170         private final List<SimulationModifier> selectedModifiers = new ArrayList<SimulationModifier>();
171         
172         /** List of components to disable while optimization is running */
173         private final List<JComponent> disableComponents = new ArrayList<JComponent>();
174         
175         /** Whether optimization is currently running or not */
176         private boolean running = false;
177         /** The optimization worker that is running */
178         private OptimizationWorker worker = null;
179         
180
181         private double bestValue = Double.NaN;
182         private Unit bestValueUnit = Unit.NOUNIT2;
183         private int stepCount = 0;
184         private int evaluationCount = 0;
185         private double stepSize = 0;
186         
187         private final Map<Point, FunctionEvaluationData> evaluationHistory = new LinkedHashMap<Point, FunctionEvaluationData>();
188         private final List<Point> optimizationPath = new LinkedList<Point>();
189         
190
191         private boolean updating = false;
192         
193         
194         /**
195          * Sole constructor.
196          * 
197          * @param document      the document
198          * @param parent        the parent window
199          */
200         public GeneralOptimizationDialog(OpenRocketDocument document, Window parent) {
201                 super(parent, trans.get("title"));
202                 
203                 this.baseDocument = document;
204                 this.documentCopy = document.copy();
205                 
206                 loadOptimizationParameters();
207                 loadSimulationModifiers();
208                 
209                 JPanel sub;
210                 JLabel label;
211                 JScrollPane scroll;
212                 String tip;
213                 
214                 JPanel panel = new JPanel(new MigLayout("fill"));
215                 
216
217                 ChangeListener clearHistoryChangeListener = new ChangeListener() {
218                         @Override
219                         public void stateChanged(ChangeEvent e) {
220                                 clearHistory();
221                         }
222                 };
223                 ActionListener clearHistoryActionListener = new ActionListener() {
224                         @Override
225                         public void actionPerformed(ActionEvent e) {
226                                 clearHistory();
227                         }
228                 };
229                 
230
231
232                 //// Selected modifiers table
233                 
234                 selectedModifierTableModel = new ParameterSelectionTableModel();
235                 selectedModifierTable = new JTable(selectedModifierTableModel);
236                 selectedModifierTable.setDefaultRenderer(Double.class, new DoubleCellRenderer());
237                 selectedModifierTable.setRowSelectionAllowed(true);
238                 selectedModifierTable.setColumnSelectionAllowed(false);
239                 selectedModifierTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
240                 
241                 // Make sure spinner editor fits into the cell height
242                 selectedModifierTable.setRowHeight(new JSpinner().getPreferredSize().height - 4);
243                 
244                 selectedModifierTable.setDefaultEditor(Double.class, new DoubleCellEditor());
245                 selectedModifierTable.setDefaultEditor(Unit.class, new UnitCellEditor() {
246                         @Override
247                         protected UnitGroup getUnitGroup(Unit value, int row, int column) {
248                                 return selectedModifiers.get(row).getUnitGroup();
249                         }
250                 });
251                 
252                 disableComponents.add(selectedModifierTable);
253                 
254                 selectedModifierTable.getSelectionModel().addListSelectionListener(new ListSelectionListener() {
255                         @Override
256                         public void valueChanged(ListSelectionEvent e) {
257                                 updateComponents();
258                         }
259                 });
260                 
261                 // Set column widths
262                 TableColumnModel columnModel = selectedModifierTable.getColumnModel();
263                 columnModel.getColumn(0).setPreferredWidth(150);
264                 columnModel.getColumn(1).setPreferredWidth(40);
265                 columnModel.getColumn(2).setPreferredWidth(40);
266                 columnModel.getColumn(3).setPreferredWidth(40);
267                 
268                 scroll = new JScrollPane(selectedModifierTable);
269                 
270                 label = new StyledLabel(trans.get("lbl.paramsToOptimize"), Style.BOLD);
271                 disableComponents.add(label);
272                 panel.add(label, "split 3, flowy");
273                 panel.add(scroll, "wmin 300lp, height 200lp, grow");
274                 selectedModifierDescription = new DescriptionArea(2, -3);
275                 disableComponents.add(selectedModifierDescription);
276                 panel.add(selectedModifierDescription, "growx");
277                 
278
279
280                 //// Add/remove buttons
281                 sub = new JPanel(new MigLayout("fill"));
282                 
283                 addButton = new JButton(Chars.LEFT_ARROW + " " + trans.get("btn.add") + "   ");
284                 addButton.setToolTipText(trans.get("btn.add.ttip"));
285                 addButton.addActionListener(new ActionListener() {
286                         @Override
287                         public void actionPerformed(ActionEvent e) {
288                                 SimulationModifier mod = getSelectedAvailableModifier();
289                                 if (mod != null) {
290                                         addModifier(mod);
291                                         clearHistory();
292                                 } else {
293                                         log.error("Attempting to add simulation modifier when none is selected");
294                                 }
295                         }
296                 });
297                 disableComponents.add(addButton);
298                 sub.add(addButton, "wrap para, sg button");
299                 
300                 removeButton = new JButton("   " + trans.get("btn.remove") + " " + Chars.RIGHT_ARROW);
301                 removeButton.setToolTipText(trans.get("btn.remove.ttip"));
302                 removeButton.addActionListener(new ActionListener() {
303                         @Override
304                         public void actionPerformed(ActionEvent e) {
305                                 SimulationModifier mod = getSelectedModifier();
306                                 if (mod == null) {
307                                         log.error("Attempting to remove simulation modifier when none is selected");
308                                         return;
309                                 }
310                                 removeModifier(mod);
311                                 clearHistory();
312                         }
313                 });
314                 disableComponents.add(removeButton);
315                 sub.add(removeButton, "wrap para*2, sg button");
316                 
317                 removeAllButton = new JButton(trans.get("btn.removeAll"));
318                 removeAllButton.setToolTipText(trans.get("btn.removeAll.ttip"));
319                 removeAllButton.addActionListener(new ActionListener() {
320                         @Override
321                         public void actionPerformed(ActionEvent e) {
322                                 log.user("Removing all selected modifiers");
323                                 selectedModifiers.clear();
324                                 selectedModifierTableModel.fireTableDataChanged();
325                                 availableModifierTree.repaint();
326                                 clearHistory();
327                         }
328                 });
329                 disableComponents.add(removeAllButton);
330                 sub.add(removeAllButton, "wrap para, sg button");
331                 
332                 panel.add(sub);
333                 
334
335
336                 //// Available modifier tree
337                 availableModifierTree = new SimulationModifierTree(documentCopy.getRocket(), simulationModifiers, selectedModifiers);
338                 availableModifierTree.getSelectionModel().addTreeSelectionListener(new TreeSelectionListener() {
339                         @Override
340                         public void valueChanged(TreeSelectionEvent e) {
341                                 updateComponents();
342                         }
343                 });
344                 
345                 // Handle double-click
346                 availableModifierTree.addMouseListener(new MouseAdapter() {
347                         @Override
348                         public void mousePressed(MouseEvent e) {
349                                 if (e.getClickCount() == 2) {
350                                         SimulationModifier mod = getSelectedAvailableModifier();
351                                         if (mod != null) {
352                                                 addModifier(mod);
353                                                 clearHistory();
354                                         } else {
355                                                 log.user("Double-clicked non-available option");
356                                         }
357                                 }
358                         }
359                 });
360                 
361                 disableComponents.add(availableModifierTree);
362                 scroll = new JScrollPane(availableModifierTree);
363                 label = new StyledLabel(trans.get("lbl.availableParams"), Style.BOLD);
364                 disableComponents.add(label);
365                 panel.add(label, "split 2, flowy");
366                 panel.add(scroll, "width 300lp, height 200lp, grow, wrap para*2");
367                 
368
369
370
371                 ////  Optimization options sub-panel
372                 
373                 sub = new JPanel(new MigLayout("fill"));
374                 TitledBorder border = BorderFactory.createTitledBorder(trans.get("lbl.optimizationOpts"));
375                 GUIUtil.changeFontStyle(border, Font.BOLD);
376                 sub.setBorder(border);
377                 disableComponents.add(sub);
378                 
379
380                 //// Simulation to optimize
381                 
382                 label = new JLabel(trans.get("lbl.optimizeSim"));
383                 tip = trans.get("lbl.optimizeSim.ttip");
384                 label.setToolTipText(tip);
385                 disableComponents.add(label);
386                 sub.add(label, "");
387                 
388                 simulationSelectionCombo = new JComboBox();
389                 simulationSelectionCombo.setToolTipText(tip);
390                 populateSimulations();
391                 simulationSelectionCombo.addActionListener(clearHistoryActionListener);
392                 disableComponents.add(simulationSelectionCombo);
393                 sub.add(simulationSelectionCombo, "growx, wrap unrel");
394                 
395
396
397                 //// Value to optimize
398                 label = new JLabel(trans.get("lbl.optimizeValue"));
399                 tip = trans.get("lbl.optimizeValue.ttip");
400                 label.setToolTipText(tip);
401                 disableComponents.add(label);
402                 sub.add(label, "");
403                 
404                 optimizationParameterCombo = new JComboBox();
405                 optimizationParameterCombo.setToolTipText(tip);
406                 populateParameters();
407                 optimizationParameterCombo.addActionListener(clearHistoryActionListener);
408                 disableComponents.add(optimizationParameterCombo);
409                 sub.add(optimizationParameterCombo, "growx, wrap unrel");
410                 
411
412
413                 //// Optimization goal
414                 label = new JLabel(trans.get("lbl.optimizeGoal"));
415                 tip = trans.get("lbl.optimizeGoal");
416                 label.setToolTipText(tip);
417                 disableComponents.add(label);
418                 sub.add(label, "");
419                 
420                 optimizationGoalCombo = new JComboBox(new String[] { GOAL_MAXIMIZE, GOAL_MINIMIZE, GOAL_SEEK });
421                 optimizationGoalCombo.setToolTipText(tip);
422                 optimizationGoalCombo.setEditable(false);
423                 optimizationGoalCombo.addActionListener(clearHistoryActionListener);
424                 disableComponents.add(optimizationGoalCombo);
425                 sub.add(optimizationGoalCombo, "growx");
426                 
427
428                 //// Optimization custom value
429                 optimizationSeekValue = new DoubleModel(0, UnitGroup.UNITS_NONE);
430                 optimizationSeekValue.addChangeListener(clearHistoryChangeListener);
431                 
432                 optimizationGoalSpinner = new JSpinner(optimizationSeekValue.getSpinnerModel());
433                 tip = trans.get("lbl.optimizeGoalValue.ttip");
434                 optimizationGoalSpinner.setToolTipText(tip);
435                 optimizationGoalSpinner.setEditor(new SpinnerEditor(optimizationGoalSpinner));
436                 disableComponents.add(optimizationGoalSpinner);
437                 sub.add(optimizationGoalSpinner, "width 30lp");
438                 
439                 optimizationGoalUnitSelector = new UnitSelector(optimizationSeekValue);
440                 optimizationGoalUnitSelector.setToolTipText(tip);
441                 disableComponents.add(optimizationGoalUnitSelector);
442                 sub.add(optimizationGoalUnitSelector, "width 20lp, wrap unrel");
443                 
444
445                 panel.add(sub, "grow");
446                 
447
448
449                 ////  Required stability sub-panel
450                 
451                 sub = new JPanel(new MigLayout("fill"));
452                 border = BorderFactory.createTitledBorder(trans.get("lbl.requireStability"));
453                 GUIUtil.changeFontStyle(border, Font.BOLD);
454                 sub.setBorder(border);
455                 disableComponents.add(sub);
456                 
457
458
459                 double ref = CaliberUnit.calculateCaliber(baseDocument.getRocket());
460                 minimumStability = new DoubleModel(ref, UnitGroup.stabilityUnits(ref));
461                 maximumStability = new DoubleModel(5 * ref, UnitGroup.stabilityUnits(ref));
462                 minimumStability.addChangeListener(clearHistoryChangeListener);
463                 maximumStability.addChangeListener(clearHistoryChangeListener);
464                 
465
466                 //// Minimum stability
467                 tip = trans.get("lbl.requireMinStability.ttip");
468                 minimumStabilitySelected = new JCheckBox(trans.get("lbl.requireMinStability"));
469                 minimumStabilitySelected.setSelected(true);
470                 minimumStabilitySelected.setToolTipText(tip);
471                 minimumStabilitySelected.addActionListener(new ActionListener() {
472                         @Override
473                         public void actionPerformed(ActionEvent e) {
474                                 updateComponents();
475                         }
476                 });
477                 disableComponents.add(minimumStabilitySelected);
478                 sub.add(minimumStabilitySelected);
479                 
480                 minimumStabilitySpinner = new JSpinner(minimumStability.getSpinnerModel());
481                 minimumStabilitySpinner.setToolTipText(tip);
482                 minimumStabilitySpinner.setEditor(new SpinnerEditor(minimumStabilitySpinner));
483                 disableComponents.add(minimumStabilitySpinner);
484                 sub.add(minimumStabilitySpinner, "growx");
485                 
486                 minimumStabilityUnitSelector = new UnitSelector(minimumStability);
487                 minimumStabilityUnitSelector.setToolTipText(tip);
488                 disableComponents.add(minimumStabilityUnitSelector);
489                 sub.add(minimumStabilityUnitSelector, "growx, wrap unrel");
490                 
491
492                 //// Maximum stability
493                 tip = trans.get("lbl.requireMaxStability.ttip");
494                 maximumStabilitySelected = new JCheckBox(trans.get("lbl.requireMaxStability"));
495                 maximumStabilitySelected.setToolTipText(tip);
496                 maximumStabilitySelected.addActionListener(new ActionListener() {
497                         @Override
498                         public void actionPerformed(ActionEvent e) {
499                                 updateComponents();
500                         }
501                 });
502                 disableComponents.add(maximumStabilitySelected);
503                 sub.add(maximumStabilitySelected);
504                 
505                 maximumStabilitySpinner = new JSpinner(maximumStability.getSpinnerModel());
506                 maximumStabilitySpinner.setToolTipText(tip);
507                 maximumStabilitySpinner.setEditor(new SpinnerEditor(maximumStabilitySpinner));
508                 disableComponents.add(maximumStabilitySpinner);
509                 sub.add(maximumStabilitySpinner, "growx");
510                 
511                 maximumStabilityUnitSelector = new UnitSelector(maximumStability);
512                 maximumStabilityUnitSelector.setToolTipText(tip);
513                 disableComponents.add(maximumStabilityUnitSelector);
514                 sub.add(maximumStabilityUnitSelector, "growx, wrap para");
515                 
516
517
518                 //              DescriptionArea desc = new DescriptionArea("Stability requirements are verified during each time step of the simulation.",
519                 //                              2, -2, false);
520                 //              desc.setViewportBorder(null);
521                 //              disableComponents.add(desc);
522                 //              sub.add(desc, "span, growx");
523                 
524
525                 panel.add(sub, "span 2, grow, wrap para*2");
526                 
527
528
529
530                 ////  Rocket figure
531                 figure = new RocketFigure(getSelectedSimulation().getConfiguration());
532                 figure.setBorderPixels(1, 1);
533                 ScaleScrollPane figureScrollPane = new ScaleScrollPane(figure);
534                 figureScrollPane.setFitting(true);
535                 panel.add(figureScrollPane, "span, split, height 200lp, grow");
536                 
537
538                 sub = new JPanel(new MigLayout("fill"));
539                 
540
541                 label = new JLabel(trans.get("status.bestValue"));
542                 tip = trans.get("status.bestValue.ttip");
543                 label.setToolTipText(tip);
544                 sub.add(label, "gapright unrel");
545                 
546                 bestValueLabel = new JLabel();
547                 bestValueLabel.setToolTipText(tip);
548                 sub.add(bestValueLabel, "wmin 60lp, wrap rel");
549                 
550
551                 label = new JLabel(trans.get("status.stepCount"));
552                 tip = trans.get("status.stepCount.ttip");
553                 label.setToolTipText(tip);
554                 sub.add(label, "gapright unrel");
555                 
556                 stepCountLabel = new JLabel();
557                 stepCountLabel.setToolTipText(tip);
558                 sub.add(stepCountLabel, "wrap rel");
559                 
560
561                 label = new JLabel(trans.get("status.evalCount"));
562                 tip = trans.get("status.evalCount");
563                 label.setToolTipText(tip);
564                 sub.add(label, "gapright unrel");
565                 
566                 evaluationCountLabel = new JLabel();
567                 evaluationCountLabel.setToolTipText(tip);
568                 sub.add(evaluationCountLabel, "wrap rel");
569                 
570
571                 label = new JLabel(trans.get("status.stepSize"));
572                 tip = trans.get("status.stepSize.ttip");
573                 label.setToolTipText(tip);
574                 sub.add(label, "gapright unrel");
575                 
576                 stepSizeLabel = new JLabel();
577                 stepSizeLabel.setToolTipText(tip);
578                 sub.add(stepSizeLabel, "wrap para");
579                 
580
581                 //// Start/Stop button
582                 
583                 startButton = new JToggleButton(START_TEXT);
584                 startButton.addActionListener(new ActionListener() {
585                         @Override
586                         public void actionPerformed(ActionEvent e) {
587                                 if (updating) {
588                                         log.debug("Updating, ignoring event");
589                                         return;
590                                 }
591                                 if (running) {
592                                         log.user("Stopping optimization");
593                                         stopOptimization();
594                                 } else {
595                                         log.user("Starting optimization");
596                                         startOptimization();
597                                 }
598                         }
599                 });
600                 sub.add(startButton, "span, growx, wrap para*2");
601                 
602
603                 plotButton = new JButton(trans.get("btn.plotPath"));
604                 plotButton.setToolTipText(trans.get("btn.plotPath.ttip"));
605                 plotButton.addActionListener(new ActionListener() {
606                         @Override
607                         public void actionPerformed(ActionEvent e) {
608                                 log.user("Plotting optimization path, dimensionality=" + selectedModifiers.size());
609                                 OptimizationPlotDialog dialog = new OptimizationPlotDialog(optimizationPath, evaluationHistory,
610                                                 selectedModifiers, getSelectedParameter(),
611                                                 UnitGroup.stabilityUnits(getSelectedSimulation().getRocket()),
612                                                 GeneralOptimizationDialog.this);
613                                 dialog.setVisible(true);
614                         }
615                 });
616                 disableComponents.add(plotButton);
617                 sub.add(plotButton, "span, growx, wrap");
618                 
619
620                 saveButton = new JButton(trans.get("btn.save"));
621                 saveButton.setToolTipText(trans.get("btn.save.ttip"));
622                 saveButton.addActionListener(new ActionListener() {
623                         @Override
624                         public void actionPerformed(ActionEvent e) {
625                                 log.user("User selected save path");
626                                 savePath();
627                         }
628                 });
629                 disableComponents.add(saveButton);
630                 sub.add(saveButton, "span, growx");
631                 
632
633
634                 panel.add(sub, "wrap para*2");
635                 
636
637
638
639                 ////  Bottom buttons
640                 
641                 applyButton = new JButton(trans.get("btn.apply"));
642                 applyButton.setToolTipText(trans.get("btn.apply.ttip"));
643                 applyButton.addActionListener(new ActionListener() {
644                         @Override
645                         public void actionPerformed(ActionEvent e) {
646                                 log.user("Applying optimization changes");
647                                 applyDesign();
648                         }
649                 });
650                 disableComponents.add(applyButton);
651                 panel.add(applyButton, "span, split, gapright para, right");
652                 
653                 resetButton = new JButton(trans.get("btn.reset"));
654                 resetButton.setToolTipText(trans.get("btn.reset.ttip"));
655                 resetButton.addActionListener(new ActionListener() {
656                         @Override
657                         public void actionPerformed(ActionEvent e) {
658                                 log.user("Resetting optimization design");
659                                 resetDesign();
660                         }
661                 });
662                 disableComponents.add(resetButton);
663                 panel.add(resetButton, "gapright para, right");
664                 
665                 closeButton = new JButton(trans.get("btn.close"));
666                 closeButton.setToolTipText(trans.get("btn.close.ttip"));
667                 closeButton.addActionListener(new ActionListener() {
668                         @Override
669                         public void actionPerformed(ActionEvent e) {
670                                 log.user("Closing optimization dialog");
671                                 stopOptimization();
672                                 GeneralOptimizationDialog.this.dispose();
673                         }
674                 });
675                 panel.add(closeButton, "right");
676                 
677
678                 this.add(panel);
679                 clearHistory();
680                 updateComponents();
681                 GUIUtil.setDisposableDialogOptions(this, null);
682         }
683         
684         
685         private void startOptimization() {
686                 if (running) {
687                         log.info("Optimization already running");
688                         return;
689                 }
690                 
691
692                 if (selectedModifiers.isEmpty()) {
693                         JOptionPane.showMessageDialog(this, trans.get("error.selectParams.text"),
694                                         trans.get("error.selectParams.title"), JOptionPane.ERROR_MESSAGE);
695                         updating = true;
696                         startButton.setSelected(false);
697                         startButton.setText(START_TEXT);
698                         updating = false;
699                         return;
700                 }
701                 
702
703                 running = true;
704                 
705                 // Update the button status
706                 updating = true;
707                 startButton.setSelected(true);
708                 startButton.setText(STOP_TEXT);
709                 updating = false;
710                 
711
712                 // Create a copy of the simulation (we're going to modify the original in the current thread)
713                 Simulation simulation = getSelectedSimulation();
714                 Rocket rocketCopy = simulation.getRocket().copyWithOriginalID();
715                 simulation = simulation.duplicateSimulation(rocketCopy);
716                 
717                 OptimizableParameter parameter = getSelectedParameter();
718                 
719                 OptimizationGoal goal;
720                 String value = (String) optimizationGoalCombo.getSelectedItem();
721                 if (GOAL_MAXIMIZE.equals(value)) {
722                         goal = new MaximizationGoal();
723                 } else if (GOAL_MINIMIZE.equals(value)) {
724                         goal = new MinimizationGoal();
725                 } else if (GOAL_SEEK.equals(value)) {
726                         goal = new ValueSeekGoal(optimizationSeekValue.getValue());
727                 } else {
728                         throw new BugException("optimizationGoalCombo had invalid value: " + value);
729                 }
730                 
731                 SimulationDomain domain;
732                 if (minimumStabilitySelected.isSelected() || maximumStabilitySelected.isSelected()) {
733                         double min, max;
734                         boolean minAbsolute, maxAbsolute;
735                         
736                         /*
737                          * Make minAbsolute/maxAbsolute consistent with each other to produce reasonable
738                          * result in plot tool tips.  Yes, this is a bit ugly.
739                          */
740
741                         // Min stability
742                         Unit unit = minimumStability.getCurrentUnit();
743                         if (unit instanceof CaliberUnit) {
744                                 min = unit.toUnit(minimumStability.getValue());
745                                 minAbsolute = false;
746                         } else {
747                                 min = minimumStability.getValue();
748                                 minAbsolute = true;
749                         }
750                         
751                         // Max stability
752                         unit = maximumStability.getCurrentUnit();
753                         if (unit instanceof CaliberUnit) {
754                                 max = unit.toUnit(maximumStability.getValue());
755                                 maxAbsolute = false;
756                         } else {
757                                 max = maximumStability.getValue();
758                                 maxAbsolute = true;
759                         }
760                         
761
762                         if (!minimumStabilitySelected.isSelected()) {
763                                 min = Double.NaN;
764                                 minAbsolute = maxAbsolute;
765                         }
766                         if (!maximumStabilitySelected.isSelected()) {
767                                 max = Double.NaN;
768                                 maxAbsolute = minAbsolute;
769                         }
770                         
771                         domain = new StabilityDomain(min, minAbsolute, max, maxAbsolute);
772                 } else {
773                         domain = new IdentitySimulationDomain();
774                 }
775                 
776                 SimulationModifier[] modifiers = selectedModifiers.toArray(new SimulationModifier[0]);
777                 
778                 // Create and start the background worker
779                 worker = new OptimizationWorker(simulation, parameter, goal, domain, modifiers) {
780                         @Override
781                         protected void done(OptimizationException exception) {
782                                 log.info("Optimization finished, exception=" + exception, exception);
783                                 
784                                 if (exception != null) {
785                                         JOptionPane.showMessageDialog(GeneralOptimizationDialog.this,
786                                                         new Object[] {
787                                                                         trans.get("error.optimizationFailure.text"),
788                                                                         exception.getLocalizedMessage()
789                                         }, trans.get("error.optimizationFailure.title"), JOptionPane.ERROR_MESSAGE);
790                                 }
791                                 
792                                 worker = null;
793                                 stopOptimization();
794                         }
795                         
796                         @Override
797                         protected void functionEvaluated(List<FunctionEvaluationData> data) {
798                                 for (FunctionEvaluationData d : data) {
799                                         evaluationHistory.put(d.getPoint(), d);
800                                         evaluationCount++;
801                                 }
802                                 updateCounters();
803                         }
804                         
805                         @Override
806                         protected void optimizationStepTaken(List<OptimizationStepData> data) {
807                                 
808                                 // Add starting point to the path
809                                 if (optimizationPath.isEmpty()) {
810                                         optimizationPath.add(data.get(0).getOldPoint());
811                                 }
812                                 
813                                 // Add other points to the path
814                                 for (OptimizationStepData d : data) {
815                                         optimizationPath.add(d.getNewPoint());
816                                 }
817                                 
818                                 // Get function value from the latest point
819                                 OptimizationStepData latest = data.get(data.size() - 1);
820                                 Point newPoint = latest.getNewPoint();
821                                 
822                                 FunctionEvaluationData pointValue = evaluationHistory.get(newPoint);
823                                 if (pointValue != null) {
824                                         bestValue = pointValue.getParameterValue().getValue();
825                                 } else {
826                                         log.error("History does not contain point " + newPoint);
827                                         bestValue = Double.NaN;
828                                 }
829                                 
830                                 // Update the simulation
831                                 Simulation sim = getSelectedSimulation();
832                                 for (int i = 0; i < newPoint.dim(); i++) {
833                                         try {
834                                                 selectedModifiers.get(i).modify(sim, newPoint.get(i));
835                                         } catch (OptimizationException e) {
836                                                 throw new BugException("Simulation modifier failed to modify the base simulation " +
837                                                                 "modifier=" + selectedModifiers.get(i), e);
838                                         }
839                                 }
840                                 figure.updateFigure();
841                                 
842                                 // Update other counter data
843                                 stepCount += data.size();
844                                 stepSize = latest.getStepSize();
845                                 updateCounters();
846                         }
847                 };
848                 worker.start();
849                 
850
851                 clearHistory();
852                 
853                 updateComponents();
854         }
855         
856         private void stopOptimization() {
857                 if (!running) {
858                         log.info("Optimization not running");
859                         return;
860                 }
861                 
862                 if (worker != null && worker.isAlive()) {
863                         log.info("Worker still running, interrupting it and setting to null");
864                         worker.interrupt();
865                         worker = null;
866                         return;
867                 }
868                 
869                 running = false;
870                 
871                 // Update the button status
872                 updating = true;
873                 startButton.setSelected(false);
874                 startButton.setText(START_TEXT);
875                 updating = false;
876                 
877
878                 updateComponents();
879         }
880         
881         
882
883
884         /**
885          * Reset the current optimization history and values.  This does not reset the design.
886          */
887         private void clearHistory() {
888                 evaluationHistory.clear();
889                 optimizationPath.clear();
890                 bestValue = Double.NaN;
891                 bestValueUnit = getSelectedParameter().getUnitGroup().getDefaultUnit();
892                 stepCount = 0;
893                 evaluationCount = 0;
894                 stepSize = 0.5;
895                 updateCounters();
896                 updateComponents();
897         }
898         
899         
900         private void applyDesign() {
901                 // TODO: MEDIUM: Apply also potential changes to simulations
902                 Rocket src = getSelectedSimulation().getRocket().copyWithOriginalID();
903                 Rocket dest = baseDocument.getRocket();
904                 try {
905                         baseDocument.startUndo(trans.get("undoText"));
906                         dest.freeze();
907                         
908                         // Remove all children
909                         while (dest.getChildCount() > 0) {
910                                 dest.removeChild(0);
911                         }
912                         
913                         // Move all children to the destination rocket
914                         while (src.getChildCount() > 0) {
915                                 RocketComponent c = src.getChild(0);
916                                 src.removeChild(0);
917                                 dest.addChild(c);
918                         }
919                         
920                 } finally {
921                         dest.thaw();
922                         baseDocument.stopUndo();
923                 }
924         }
925         
926         
927         private void resetDesign() {
928                 clearHistory();
929                 
930                 documentCopy = baseDocument.copy();
931                 
932                 loadOptimizationParameters();
933                 loadSimulationModifiers();
934                 
935                 // Replace selected modifiers with corresponding new modifiers
936                 List<SimulationModifier> newSelected = new ArrayList<SimulationModifier>();
937                 for (SimulationModifier original : selectedModifiers) {
938                         List<SimulationModifier> newModifiers = simulationModifiers.get(original.getRelatedObject());
939                         if (newModifiers != null) {
940                                 int index = newModifiers.indexOf(original);
941                                 if (index >= 0) {
942                                         SimulationModifier updated = newModifiers.get(index);
943                                         updated.setMinValue(original.getMinValue());
944                                         updated.setMaxValue(original.getMaxValue());
945                                         newSelected.add(updated);
946                                 }
947                         }
948                 }
949                 selectedModifiers.clear();
950                 selectedModifiers.addAll(newSelected);
951                 selectedModifierTableModel.fireTableDataChanged();
952                 
953                 // Update the available modifier tree
954                 availableModifierTree.populateTree(documentCopy.getRocket(), simulationModifiers);
955                 availableModifierTree.expandComponents();
956                 
957
958                 // Update selectable simulations
959                 populateSimulations();
960                 
961                 // Update selectable parameters
962                 populateParameters();
963                 
964         }
965         
966         
967         private void populateSimulations() {
968                 String current = null;
969                 Object selection = simulationSelectionCombo.getSelectedItem();
970                 if (selection != null) {
971                         current = selection.toString();
972                 }
973                 
974
975                 List<Named<Simulation>> simulations = new ArrayList<Named<Simulation>>();
976                 Rocket rocket = documentCopy.getRocket();
977                 
978                 for (Simulation s : documentCopy.getSimulations()) {
979                         String id = s.getConfiguration().getMotorConfigurationID();
980                         String name = createSimulationName(s.getName(), rocket.getMotorConfigurationNameOrDescription(id));
981                         simulations.add(new Named<Simulation>(s, name));
982                 }
983                 
984                 for (String id : rocket.getMotorConfigurationIDs()) {
985                         if (id == null) {
986                                 continue;
987                         }
988                         Simulation sim = new Simulation(rocket);
989                         sim.getConfiguration().setMotorConfigurationID(id);
990                         String name = createSimulationName(trans.get("basicSimulationName"), rocket.getMotorConfigurationNameOrDescription(id));
991                         simulations.add(new Named<Simulation>(sim, name));
992                 }
993                 
994
995                 Simulation sim = new Simulation(rocket);
996                 sim.getConfiguration().setMotorConfigurationID(null);
997                 String name = createSimulationName(trans.get("noSimulationName"), rocket.getMotorConfigurationNameOrDescription(null));
998                 simulations.add(new Named<Simulation>(sim, name));
999                 
1000
1001                 simulationSelectionCombo.setModel(new DefaultComboBoxModel(simulations.toArray()));
1002                 
1003                 if (current != null) {
1004                         for (int i = 0; i < simulations.size(); i++) {
1005                                 if (simulations.get(i).toString().equals(current)) {
1006                                         simulationSelectionCombo.setSelectedIndex(i);
1007                                         break;
1008                                 }
1009                         }
1010                 }
1011         }
1012         
1013         
1014         private void populateParameters() {
1015                 String current = null;
1016                 Object selection = optimizationParameterCombo.getSelectedItem();
1017                 if (selection != null) {
1018                         current = selection.toString();
1019                 } else {
1020                         // Default to apogee altitude event if it is not the first one in the list
1021                         current = trans.get("MaximumAltitudeParameter.name");
1022                 }
1023                 
1024                 List<Named<OptimizableParameter>> parameters = new ArrayList<Named<OptimizableParameter>>();
1025                 for (OptimizableParameter p : optimizationParameters) {
1026                         parameters.add(new Named<OptimizableParameter>(p, p.getName()));
1027                 }
1028                 
1029                 optimizationParameterCombo.setModel(new DefaultComboBoxModel(parameters.toArray()));
1030                 
1031                 for (int i = 0; i < parameters.size(); i++) {
1032                         if (parameters.get(i).toString().equals(current)) {
1033                                 optimizationParameterCombo.setSelectedIndex(i);
1034                                 break;
1035                         }
1036                 }
1037         }
1038         
1039         private void updateCounters() {
1040                 bestValueLabel.setText(bestValueUnit.toStringUnit(bestValue));
1041                 stepCountLabel.setText("" + stepCount);
1042                 evaluationCountLabel.setText("" + evaluationCount);
1043                 stepSizeLabel.setText(UnitGroup.UNITS_RELATIVE.toStringUnit(stepSize));
1044         }
1045         
1046         
1047         private void loadOptimizationParameters() {
1048                 optimizationParameters.clear();
1049                 optimizationParameters.addAll(OptimizationServiceHelper.getOptimizableParameters(documentCopy));
1050                 
1051                 if (optimizationParameters.isEmpty()) {
1052                         throw new BugException("No rocket optimization parameters found, distribution built wrong.");
1053                 }
1054                 
1055                 Collections.sort(optimizationParameters, new Comparator<OptimizableParameter>() {
1056                         @Override
1057                         public int compare(OptimizableParameter o1, OptimizableParameter o2) {
1058                                 return o1.getName().compareTo(o2.getName());
1059                         }
1060                 });
1061         }
1062         
1063         
1064         private void loadSimulationModifiers() {
1065                 simulationModifiers.clear();
1066                 
1067                 for (SimulationModifier m : OptimizationServiceHelper.getSimulationModifiers(documentCopy)) {
1068                         Object key = m.getRelatedObject();
1069                         List<SimulationModifier> list = simulationModifiers.get(key);
1070                         if (list == null) {
1071                                 list = new ArrayList<SimulationModifier>();
1072                                 simulationModifiers.put(key, list);
1073                         }
1074                         list.add(m);
1075                 }
1076                 
1077                 for (Object key : simulationModifiers.keySet()) {
1078                         List<SimulationModifier> list = simulationModifiers.get(key);
1079                         Collections.sort(list, new Comparator<SimulationModifier>() {
1080                                 @Override
1081                                 public int compare(SimulationModifier o1, SimulationModifier o2) {
1082                                         return o1.getName().compareTo(o2.getName());
1083                                 }
1084                         });
1085                 }
1086                 
1087         }
1088         
1089         
1090
1091         private void addModifier(SimulationModifier mod) {
1092                 if (!selectedModifiers.contains(mod)) {
1093                         log.user(1, "Adding simulation modifier " + mod);
1094                         selectedModifiers.add(mod);
1095                         Collections.sort(selectedModifiers, new SimulationModifierComparator());
1096                         selectedModifierTableModel.fireTableDataChanged();
1097                         availableModifierTree.repaint();
1098                 } else {
1099                         log.user(1, "Attempting to add an already existing simulation modifier " + mod);
1100                 }
1101         }
1102         
1103         
1104         private void removeModifier(SimulationModifier mod) {
1105                 log.user(1, "Removing simulation modifier " + mod);
1106                 selectedModifiers.remove(mod);
1107                 selectedModifierTableModel.fireTableDataChanged();
1108                 availableModifierTree.repaint();
1109         }
1110         
1111         
1112
1113         /**
1114          * Update the enabled status of all components in the dialog.
1115          */
1116         private void updateComponents() {
1117                 
1118                 if (updating) {
1119                         return;
1120                 }
1121                 
1122                 updating = true;
1123                 
1124
1125                 // First enable all components if optimization not running
1126                 if (!running) {
1127                         for (JComponent c : disableComponents) {
1128                                 c.setEnabled(true);
1129                         }
1130                 }
1131                 
1132
1133                 // "Add" button
1134                 SimulationModifier mod = getSelectedAvailableModifier();
1135                 if (mod != null && !selectedModifiers.contains(mod)) {
1136                         addButton.setEnabled(true);
1137                 } else {
1138                         addButton.setEnabled(false);
1139                 }
1140                 
1141                 // "Remove" button
1142                 removeButton.setEnabled(selectedModifierTable.getSelectedRow() >= 0);
1143                 
1144                 // "Remove all" button
1145                 removeAllButton.setEnabled(!selectedModifiers.isEmpty());
1146                 
1147
1148                 // Optimization goal
1149                 String selected = (String) optimizationGoalCombo.getSelectedItem();
1150                 if (GOAL_SEEK.equals(selected)) {
1151                         optimizationGoalSpinner.setVisible(true);
1152                         optimizationGoalUnitSelector.setVisible(true);
1153                 } else {
1154                         optimizationGoalSpinner.setVisible(false);
1155                         optimizationGoalUnitSelector.setVisible(false);
1156                 }
1157                 
1158
1159                 // Minimum/maximum stability options
1160                 minimumStabilitySpinner.setEnabled(minimumStabilitySelected.isSelected());
1161                 minimumStabilityUnitSelector.setEnabled(minimumStabilitySelected.isSelected());
1162                 maximumStabilitySpinner.setEnabled(maximumStabilitySelected.isSelected());
1163                 maximumStabilityUnitSelector.setEnabled(maximumStabilitySelected.isSelected());
1164                 
1165
1166                 // Plot button (enabled if path exists and dimensionality is 1 or 2)
1167                 plotButton.setEnabled(!optimizationPath.isEmpty() && (selectedModifiers.size() == 1 || selectedModifiers.size() == 2));
1168                 
1169                 // Save button (enabled if path exists)
1170                 saveButton.setEnabled(!optimizationPath.isEmpty());
1171                 
1172
1173                 // Last disable all components if optimization is running
1174                 if (running) {
1175                         for (JComponent c : disableComponents) {
1176                                 c.setEnabled(false);
1177                         }
1178                 }
1179                 
1180
1181                 // Update description text
1182                 mod = getSelectedModifier();
1183                 if (mod != null) {
1184                         selectedModifierDescription.setText(mod.getDescription());
1185                 } else {
1186                         selectedModifierDescription.setText("");
1187                 }
1188                 
1189
1190                 // Update the figure
1191                 figure.setConfiguration(getSelectedSimulation().getConfiguration());
1192                 
1193                 updating = false;
1194         }
1195         
1196         
1197         private void savePath() {
1198                 
1199                 if (evaluationHistory.isEmpty()) {
1200                         throw new BugException("evaluation history is empty");
1201                 }
1202                 
1203                 CsvOptionPanel csvOptions = new CsvOptionPanel(GeneralOptimizationDialog.class,
1204                                 trans.get("export.header"), trans.get("export.header.ttip"));
1205                 
1206
1207                 JFileChooser chooser = new JFileChooser();
1208                 chooser.setFileFilter(FileHelper.CSV_FILE_FILTER);
1209                 chooser.setCurrentDirectory(Prefs.getDefaultDirectory());
1210                 chooser.setAccessory(csvOptions);
1211                 
1212                 if (chooser.showSaveDialog(this) != JFileChooser.APPROVE_OPTION)
1213                         return;
1214                 
1215                 File file = chooser.getSelectedFile();
1216                 if (file == null)
1217                         return;
1218                 
1219                 file = FileHelper.ensureExtension(file, "csv");
1220                 if (!FileHelper.confirmWrite(file, this)) {
1221                         return;
1222                 }
1223                 
1224                 String fieldSeparator = csvOptions.getFieldSeparator();
1225                 String commentCharacter = csvOptions.getCommentCharacter();
1226                 boolean includeHeader = csvOptions.getSelectionOption(0);
1227                 csvOptions.storePreferences();
1228                 
1229                 log.info("Saving optimization path to " + file + ", fieldSeparator=" + fieldSeparator +
1230                                 ", commentCharacter=" + commentCharacter + ", includeHeader=" + includeHeader);
1231                 
1232                 try {
1233                         Writer writer = new BufferedWriter(new FileWriter(file));
1234                         
1235                         // Write header
1236                         if (includeHeader) {
1237                                 FunctionEvaluationData data = evaluationHistory.values().iterator().next();
1238                                 
1239                                 writer.write(commentCharacter);
1240                                 for (SimulationModifier mod : selectedModifiers) {
1241                                         writer.write(mod.getRelatedObject().toString() + ": " + mod.getName() + " / " +
1242                                                         mod.getUnitGroup().getDefaultUnit().getUnit());
1243                                         writer.write(fieldSeparator);
1244                                 }
1245                                 if (minimumStabilitySelected.isSelected() || maximumStabilitySelected.isSelected()) {
1246                                         writer.write(trans.get("export.stability") + " / " + data.getDomainReference().getUnit().getUnit());
1247                                         writer.write(fieldSeparator);
1248                                 }
1249                                 writer.write(getSelectedParameter().getName() + " / " +
1250                                                 getSelectedParameter().getUnitGroup().getDefaultUnit().getUnit());
1251                                 
1252                                 writer.write("\n");
1253                         }
1254                         
1255
1256                         for (FunctionEvaluationData data : evaluationHistory.values()) {
1257                                 Value[] state = data.getState();
1258                                 
1259                                 for (int i = 0; i < state.length; i++) {
1260                                         writer.write(TextUtil.doubleToString(state[i].getUnitValue()));
1261                                         writer.write(fieldSeparator);
1262                                 }
1263                                 
1264                                 if (minimumStabilitySelected.isSelected() || maximumStabilitySelected.isSelected()) {
1265                                         writer.write(TextUtil.doubleToString(data.getDomainReference().getUnitValue()));
1266                                         writer.write(fieldSeparator);
1267                                 }
1268                                 
1269                                 if (data.getParameterValue() != null) {
1270                                         writer.write(TextUtil.doubleToString(data.getParameterValue().getUnitValue()));
1271                                 } else {
1272                                         writer.write("N/A");
1273                                 }
1274                                 writer.write("\n");
1275                         }
1276                         
1277                         writer.close();
1278                         log.info("File successfully saved");
1279                         
1280                 } catch (IOException e) {
1281                         FileHelper.errorWriting(e, this);
1282                 }
1283                 
1284         }
1285         
1286         /**
1287          * Return the currently selected available simulation modifier from the modifier tree,
1288          * or <code>null</code> if none selected.
1289          */
1290         private SimulationModifier getSelectedAvailableModifier() {
1291                 TreePath treepath = availableModifierTree.getSelectionPath();
1292                 if (treepath != null) {
1293                         Object o = ((DefaultMutableTreeNode) treepath.getLastPathComponent()).getUserObject();
1294                         if (o instanceof SimulationModifier) {
1295                                 return (SimulationModifier) o;
1296                         }
1297                 }
1298                 return null;
1299         }
1300         
1301         /**
1302          * Return the currently selected simulation.
1303          * @return      the selected simulation.
1304          */
1305         @SuppressWarnings("unchecked")
1306         private Simulation getSelectedSimulation() {
1307                 return ((Named<Simulation>) simulationSelectionCombo.getSelectedItem()).get();
1308         }
1309         
1310         
1311         /**
1312          * Return the currently selected simulation modifier from the table,
1313          * or <code>null</code> if none selected.
1314          * @return      the selected modifier or <code>null</code>.
1315          */
1316         private SimulationModifier getSelectedModifier() {
1317                 int row = selectedModifierTable.getSelectedRow();
1318                 if (row < 0) {
1319                         return null;
1320                 }
1321                 row = selectedModifierTable.convertRowIndexToModel(row);
1322                 return selectedModifiers.get(row);
1323         }
1324         
1325         
1326         /**
1327          * Return the currently selected optimization parameter.
1328          * @return      the selected optimization parameter.
1329          */
1330         @SuppressWarnings("unchecked")
1331         private OptimizableParameter getSelectedParameter() {
1332                 return ((Named<OptimizableParameter>) optimizationParameterCombo.getSelectedItem()).get();
1333         }
1334         
1335         
1336         private Unit getModifierUnit(int index) {
1337                 return selectedModifiers.get(index).getUnitGroup().getDefaultUnit();
1338         }
1339         
1340         private String createSimulationName(String simulationName, String motorConfiguration) {
1341                 String name;
1342                 boolean hasParenthesis = motorConfiguration.matches("^[\\[\\(].*[\\]\\)]$");
1343                 name = simulationName + " ";
1344                 if (!hasParenthesis) {
1345                         name += "(";
1346                 }
1347                 name += motorConfiguration;
1348                 if (!hasParenthesis) {
1349                         name += ")";
1350                 }
1351                 return name;
1352         }
1353         
1354         /**
1355          * The table model for the parameter selection.
1356          * 
1357          * [Body tube: Length]  [min]  [max]  [unit]
1358          */
1359         private class ParameterSelectionTableModel extends AbstractTableModel {
1360                 
1361                 private static final int PARAMETER = 0;
1362                 private static final int CURRENT = 1;
1363                 private static final int MIN = 2;
1364                 private static final int MAX = 3;
1365                 private static final int COUNT = 4;
1366                 
1367                 @Override
1368                 public int getColumnCount() {
1369                         return COUNT;
1370                 }
1371                 
1372                 @Override
1373                 public int getRowCount() {
1374                         return selectedModifiers.size();
1375                 }
1376                 
1377                 @Override
1378                 public String getColumnName(int column) {
1379                         switch (column) {
1380                         case PARAMETER:
1381                                 return trans.get("table.col.parameter");
1382                         case CURRENT:
1383                                 return trans.get("table.col.current");
1384                         case MIN:
1385                                 return trans.get("table.col.min");
1386                         case MAX:
1387                                 return trans.get("table.col.max");
1388                         default:
1389                                 throw new IndexOutOfBoundsException("column=" + column);
1390                         }
1391                         
1392                 }
1393                 
1394                 @Override
1395                 public Class<?> getColumnClass(int column) {
1396                         switch (column) {
1397                         case PARAMETER:
1398                                 return String.class;
1399                         case CURRENT:
1400                                 return Double.class;
1401                         case MIN:
1402                                 return Double.class;
1403                         case MAX:
1404                                 return Double.class;
1405                         default:
1406                                 throw new IndexOutOfBoundsException("column=" + column);
1407                         }
1408                 }
1409                 
1410                 @Override
1411                 public Object getValueAt(int row, int column) {
1412                         
1413                         SimulationModifier modifier = selectedModifiers.get(row);
1414                         
1415                         switch (column) {
1416                         case PARAMETER:
1417                                 return modifier.getRelatedObject().toString() + ": " + modifier.getName();
1418                         case CURRENT:
1419                                 try {
1420                                         return getModifierUnit(row).toUnit(modifier.getCurrentSIValue(getSelectedSimulation()));
1421                                 } catch (OptimizationException e) {
1422                                         throw new BugException("Could not read current SI value from modifier " + modifier, e);
1423                                 }
1424                         case MIN:
1425                                 return getModifierUnit(row).toUnit(modifier.getMinValue());
1426                         case MAX:
1427                                 return getModifierUnit(row).toUnit(modifier.getMaxValue());
1428                         default:
1429                                 throw new IndexOutOfBoundsException("column=" + column);
1430                         }
1431                         
1432                 }
1433                 
1434                 @Override
1435                 public void setValueAt(Object value, int row, int column) {
1436                         
1437                         switch (column) {
1438                         case PARAMETER:
1439                                 break;
1440                         
1441                         case MIN:
1442                                 double min = (Double) value;
1443                                 min = getModifierUnit(row).fromUnit(min);
1444                                 selectedModifiers.get(row).setMinValue(min);
1445                                 break;
1446                         
1447                         case CURRENT:
1448                                 break;
1449                         
1450                         case MAX:
1451                                 double max = (Double) value;
1452                                 max = getModifierUnit(row).fromUnit(max);
1453                                 selectedModifiers.get(row).setMaxValue(max);
1454                                 break;
1455                         
1456                         default:
1457                                 throw new IndexOutOfBoundsException("column=" + column);
1458                         }
1459                         this.fireTableRowsUpdated(row, row);
1460                         
1461                 }
1462                 
1463                 @Override
1464                 public boolean isCellEditable(int row, int column) {
1465                         switch (column) {
1466                         case PARAMETER:
1467                                 return false;
1468                         case CURRENT:
1469                                 return false;
1470                         case MIN:
1471                                 return true;
1472                         case MAX:
1473                                 return true;
1474                         default:
1475                                 throw new IndexOutOfBoundsException("column=" + column);
1476                         }
1477                 }
1478                 
1479         }
1480         
1481         
1482         private class DoubleCellRenderer extends DefaultTableCellRenderer {
1483                 @Override
1484                 public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected,
1485                                 boolean hasFocus, int row, int column) {
1486                         
1487                         super.getTableCellRendererComponent(table, value, isSelected, hasFocus, row, column);
1488                         
1489                         double val = (Double) value;
1490                         Unit unit = getModifierUnit(row);
1491                         
1492                         val = unit.fromUnit(val);
1493                         this.setText(unit.toStringUnit(val));
1494                         
1495                         return this;
1496                 }
1497         }
1498         
1499         
1500         private static class SimulationModifierComparator implements Comparator<SimulationModifier> {
1501                 
1502                 @Override
1503                 public int compare(SimulationModifier mod1, SimulationModifier mod2) {
1504                         Object rel1 = mod1.getRelatedObject();
1505                         Object rel2 = mod2.getRelatedObject();
1506                         
1507                         /*
1508                          * Primarily order by related object:
1509                          * 
1510                          * - RocketComponents first
1511                          * - Two RocketComponents are ordered based on their position in the rocket
1512                          */
1513                         if (!rel1.equals(rel2)) {
1514                                 
1515                                 if (rel1 instanceof RocketComponent) {
1516                                         if (rel2 instanceof RocketComponent) {
1517                                                 
1518                                                 RocketComponent root = ((RocketComponent) rel1).getRoot();
1519                                                 for (RocketComponent c : root) {
1520                                                         if (c.equals(rel1)) {
1521                                                                 return -1;
1522                                                         }
1523                                                         if (c.equals(rel2)) {
1524                                                                 return 1;
1525                                                         }
1526                                                 }
1527                                                 
1528                                                 throw new BugException("Error sorting modifiers, mod1=" + mod1 + " rel1=" + rel1 +
1529                                                                 " mod2=" + mod2 + " rel2=" + rel2);
1530                                                 
1531                                         } else {
1532                                                 return -1;
1533                                         }
1534                                 } else {
1535                                         if (rel2 instanceof RocketComponent) {
1536                                                 return 1;
1537                                         }
1538                                 }
1539                                 
1540                         }
1541                         
1542                         // Secondarily sort by name
1543                         return collator.compare(mod1.getName(), mod2.getName());
1544                 }
1545         }
1546         
1547
1548
1549 }