Editing Developer's Guide

{{Access}}

This page contains information on the inner workings of OpenRocket and is meant primarily for developers interested in developing OpenRocket.

In addition to this page, information can be found in the [http://openrocket.sourceforge.net/documentation.html Technical documentation] chapter 5.

== Obtaining the source code ==

OpenRocket is primarily developed using [http://www.eclipse.org/ Eclipse], and it's the recommended IDE for compatibility.  Developers are free to use other IDE's, but everything may not work out-of-the-box.

The source code is hosted on [https://github.com/openrocket/openrocket/ GitHub].  You need either to install the [http://www.eclipse.org/egit/ EGit] plugin to Eclipse, or use some other Git client (for example the command-line client).

Using the command-line, the OpenRocket code can be retrieved by:

<pre>
$ git clone git://github.com/openrocket/openrocket.git
</pre>


'''Note:''' The source packages available on the OpenRocket web site (*.zip) are meant for building the application from source code, '''NOT''' for development purposes.  They do not contain all the project files etc 

== Running OpenRocket from Eclipse (tested with Eclipse Luna and OpenRocket v15.03, September, 2015) ==

The following steps should get you up and running with OpenRocket source code: <br/>

1) After downloading the source code, start Eclipse. <br/>
2) From the Eclipse main menu, select <b>File</b> -> <b>Import</b>. <br/> 
3) In the <i>Import</i> window that opens, select <b>General</b> -> <b>Existing Projects into Workspace</b>, then click <b>Next</b>. <br/>
4) In the <i>Select root directory</i> field, browse to the location of the OpenRocket source code that you downloaded. <br/>
5) In the file browser that appears, click on the <b>openrocket</b> root project directory. A list of projects should then appear in the <i>Projects</i> pane on the import window. <br/>
6) Select only these three projects from the list: <b>OpenRocket Core</b>, <b>OpenRocket Swing</b> and <b>OpenRocket Test Libraries</b>. (Note: As of v15.03 you no longer need to load the other projects to build OpenRocket on the desktop.) <br/>
7) Once those three projects have been selected, click <b>Finish</b>. Eclipse should start with those three projects shown in the <i>Package Explorer</i>. <br/>

<i>NOTE: You might see errors in some source files, reporting that various Java classes cannot be found. If that happens, you might try these steps to resolve these issues: </i> <br/>

8) In the <i>Project Explorer</i> pane in Eclipse, right-click on the project reporting the errors. Select <b>Properties</b>. <br/>
9) In the properties window that opens, select <b>Java Build Path</b> -> <b>Libraries</b>. <br/>
10) Make sure that the <i>JRE System Library</i> for your version of Java is seen in the list of libraries. <br/>
11) If it is NOT included in the list, click the <b>Add Library</b> button in the menu to the right. <br/>
12) From the <i>Add Library</i> window that appears, select <b>JRE System Library</b> from the list. Then click <b>Next</b>. <br/>
13) Make sure that the correct <i>Workspace</i> is selected in the next window that appears, and then click <b>Finish</b>. Once the <i>Add Library</i> window closes, you should then see the JRE System Library added to the list of libraries in the project properties window. <br/>
14) Click <b>OK</b>. Once the project properties window closes you will be returned to Eclipse, and hopefully the errors reported by the IDE will then resolve. <br/>
15) If there are still errors, you'll need to revert to Google for additional help. Googling the exact error string reported by Eclipse will most likely help you resolve any outstanding dependency issues. <br/>

<b>***</b> Also note that the main entry point for OpenRocket is in the <i>OpenRocket Swing</i> project, in the <b>net.sf.openrocket.startup.SwingStartup.java</b> file. With that file active OpenRocket should build and start. <br/>

Finally, remember that help is available either in the OpenRocket forums or in the main developers list. Good Luck! <br/> <br/>

== Marking TODO's ==

Often when writing code you know that something could be done better, but at the moment is either impossible or unreasonable.  These are commonly marked with a TODO comment.  The following convension is used to mark the importance of different TODO's:

* <code>// TODO: CRITICAL: Some comment</code> <br> A bug or something that is not yet implemented, and must be corrected before any release is made.  The Ant build script checks for these and prevents building if such a comment is found.
* <code>// TODO: HIGH: Some comment</code> <br> An important issue that should be looked into within this or the next major release.
* <code>// TODO: MEDIUM: Some comment</code> <br> Something that would make the software better, but does not represent a problem as such.
* <code>// TODO: LOW: Some comment</code> <br> Something that would be nice to do better in the future

== Debugging ==

=== LogBack ===

As of version 13.05, OpenRocket uses [http://logback.qos.ch/index.html LogBack] for logging.

If you want to change the default logging that OpenRocket uses, you can create or reuse a LogBack configuration file stored in openrocket/core/config. For example, you can use the logback-stdout-level-error.xml there which tells logback to log everything to stdout with logging level of Error (serious errors only).

To enable use of a LogBack configuration file, pass the JVM the following option during startup:

 -Dlogback.configurationFile=config/logback-stdout-level-error.xml 

See the [http://logback.qos.ch/manual/configuration.html LogBack configuration page] for more details. 

=== Probably Obsolete Debugging Info ===

Log messages in openrocket are specified by one of six levels. You can specify which level of errors you want reported to standard out with a system property which you can add to your VM argument, e.g:
 
 -Dopenrocket.log.stdout=debug

The error levels available are:

: '''ERROR''' - Level for indicating a bug or error condition noticed in the software or JRE. No ERROR level events _should_ occur while running the program.
	
: '''WARN''' - Level for indicating error conditions or atypical events that can occur during normal operation (errors while loading files, weird computation results etc).

: '''USER''' - Level for logging user actions (adding and modifying components, running simulations etc).  A user action should be logged as soon as possible on this level.  The level is separate so that additional INFO messages won't purge user actions from a bounded log buffer.

: '''INFO''' - Level for indicating general level actions the software is performing and other notable events during execution (dialogs shown, simulations run etc)
	
: '''DEBUG''' - Level for indicating mid-results, outcomes of methods and other debugging information.  The data logged should be of value when analyzing error conditions and what has caused them.  Places that are called repeatedly during e.g. flight simulation should use the VBOSE level instead.

: '''VBOSE''' - Level of verbose debug logging to be used in areas which are called repeatedly, such as computational methods used in simulations.  This level is separated to allow filtering out the verbose logs generated during simulations, DnD etc. from the normal debug logs.

In the code, the standard way to log errors is with 
 
 log.verbose("Error message");

where log is defined in each class as :
 
 private static final LogHelper log = Application.getLogger();

== Units used in OpenRocket ==

OpenRocket always uses internally pure SI units.  For example all rocket dimensions and flight distances are in meters, all masses are in kilograms, density is in kg/m³, temperature is in Kelvin etc.  This convension is also used when storing the design in the OpenRocket format.

The only exception to this rule is angles:
* Angles are represented as radians internally, but in the file format they are converted to degrees.  This is to make the file format more human-readable and to avoid rounding errors.
* Latitude and longitude of the launch site are represented in degrees both internally and externally.

When displaying measures to the user, the values are converted into the preferred units of the user.  This is performed using classes in the package <tt>net.sf.openrocket.unit</tt>.  The <tt>Unit</tt> class represents a single unit and it includes methods for converting between that unit and SI units in addition to creating a string representation with a suitable amount of decimals.  A <tt>UnitGroup</tt> describes a measurable quantity such as temperature and contains the units available for that quantity, such as Celcius, Fahrenheit and Kelvin.


== Rocket design loading and saving ==

''(This section is based on email correspondence)''


All file reading/writing is performed in the package
<tt>net.sf.openrocket.file</tt> and subpackages.  To implement a new
document loader it is necessary to extend the class <tt>RocketLoader</tt> and
implement the abstract method <tt>loadFromStream(InputStream)</tt>.  This
method simply loads the document and returns an <tt>OpenRocketDocument</tt>
object.

An <tt>OpenRocketDocument</tt> contains all the information about an opened
document, primarily the rocket structure and the simulations.  The
rocket structure is a simple tree-like structure of <tt>RocketComponents</tt>.
All of the components are in the package <tt>.rocketcomponent</tt>.  A diagram
of their hierarchy and a short explanation of each class is available
in my thesis section 5.1
(http://openrocket.sourceforge.net/documentation.html)

I've implemented a simple XML reading framework (based on SAX), which
simplifies reading by assuming that XML elements can contain only
other elements or text content, but not both.  Both the OpenRocket and
Rocksim format abide with this restriction.

The framework is in the package <tt>.file.simplesax</tt>.  The primary class
that will be extended is <tt>ElementHandler</tt>, which contains three methods.
<tt>openElement()</tt> is called when a new subelement is found, and it
returns a new <tt>ElementHandler</tt> to handle that element (which can be the
object itself), or <tt>null</tt> in order to ignore that element and all of its
contents (for example for unknown elements). <tt>closeElement()</tt> is called
when the subelement ends, and <tt>endHandler()</tt> is called when the element
of the current handler ends.  The JavaDoc should provide the necessary
details.

There are a few ready handlers, the most useful of which will probably
be <tt>PlainTextHandler</tt>.  This handler accepts only text content and
ignores all subelements.  If the XML file contains
<nowiki><element>value</element></nowiki>, then the handler can return a
<tt>PlainTextHandler</tt> and handle the content within the <tt>closeElement()</tt>
method, removing the need to write a specialized handler for that
element.

The XML reading is initiated by calling <tt>SimpleSAX.readXML()</tt> with the
input source and the initial <tt>ElementHandler</tt>.

The OpenRocket document loading is implemented in
<tt>.file.openrocket.OpenRocketLoader</tt>.  Here I've used a bit more
boilerplate code to be able to define most of the rocket structure
preferences without needing separate handlers for them.


=== The OpenRocket format (*.ork) ===

The OpenRocket native format uses the file extension *.ork.  It is an XML format, which can optionally be compressed using GZIP.  (The extension *.ork.gz is also accepted by the dialogs, though plain .ork is recommended.)

Currently the file format is not documented other than as the reference implementation, and no XML schema exists.  This will hopefully change in the future.  See [[#Units used in OpenRocket]] for details on units.

Every time the XML format changes, the file version number is increased.  This version number is not linked to the version of OpenRocket that created the file, but instead describes the file format.  Later versions of OpenRocket should attempt to store files in the oldest format that supports all the necessary features.  The changes in the format are described in the [http://openrocket.svn.sourceforge.net/viewvc/openrocket/trunk/fileformat.txt fileformat.txt file in SVN].