If you have been granted write-permission to the SAVE-IDE repository, please read this document and 'The Complete Guideline for Developers'. The complete Guideline for Developers can be found at .
NOTE: This software is still in pre-alpha state, and therefore this installation guide will be subject of major changes. This installation guide will give you a SAVE-IDE in Eclipse for both users and developers. In the future the user and developer installation guide will be separated and put into the user and developer manual respectively.
There are two ways to install the Eclipse (TM) framework and needed plugins. Either install a distribution that have pre-installed plugins that is needed for the SAVE-IDE, e.g., Acceleo Distribution. Or install a 'clean' Eclipse framework and add the plug-ins required. The former may lead to more installed features than neccesary.
- Unzip the file.
- Note 1: If you use Windows XP built-in archive program you will be asked for a password. Use another archive program, e.g. WinRAR or WinZip.
- Note 2: Unzip the distribution to a directory with a short directory name, e.g. 'c:\eclipse', otherwise som file names will be too long.
- Note 3: Do not use spaces in the path and file name to avoid future problems. Replace space with underscore, e.g., 'my file.ext' should be named 'my_file.ext'.
- Start Eclispe by double clicking eclipse.exe in the directory you have chosen in the previous step (e.g. 'c:\eclipse').
- Choosing the default workspace location should work fine (also instruct Eclipse to never ask this again). (If you later on want to start in another workspace you can change the workspace from within Eclipse.)
- Click "Workspace, Go to the workspace"
- Update plugins of the Eclipse installation
- Menu Help -> Software Updates -> Find and Install
- Select "Search for new feature to install"
- Check "The Eclipse Project Update"
- Select Finish
- Select e.g. the ftp mirror in Switzerland (and follow the instructions)
- Check everything and *UN*check Eclipse 3.3.1 patches
- Exit Eclipse (i.e. do not restart)
- Install SAVE IDE
- Download the SAVE-IDE plugins. This can be done from two places SAVE-IDE download page or downloaded by getting the latest snapshot from the 'trunk/snapshots'.
- Copy the SAVE-IDE plug-ins from plugins_yyyymmdd.zip into the Eclipse's plug-ins directory.
- Or, alternatively extract the files directly into Eclipse's plug-ins directory.
- Download the UPPAAL-port for SAVE-IDE:
- Put the plugin (.jar file) in the "plugins" directory of your Eclipse installation.
- Start eclipse, click "Window->Preferences...". Find the "UPPAAL PORT" preferences page.
- Select the location of "portsrv.exe" (it is in the "bin" directory of the archive).
- Now, you should be done :-) However, you are not :-( Here is a workaround that should not be needed soon ;-)
- Download ide_yyyymmdd.zip and unzip the file 'se.mdh.mrtc.save.TADiagramEditor.generation\generator.mt'.
- In the Package Explorer tab, create a Project by selecting New -> Project -> General -> Project and name the project "se.mdh.mrtc.save.TADiagramEditor.generation".
- Right-click the new project and select Import -> General -> File system and select the file generator.mt.
- Do this if you want to update Eclipse to ensure that you have the newest updates your eclipse. These steps are done from within Eclipse.
- Chose the from the menu:
- 'Help->Software Update->Find and install' will bring up the 'Install/Update' dialog.
- Select the 'Search for updates of the currently installed features' option and click the 'Finish' button. This will take you to a new dialog.
- Select 'Eclipse project Update' site.
Note: By selecting the 'Automatically select mirrors' option the update chose the nearest update server, not necessarily the fastest. If you have selected the 'Automatically select mirrors' option previously it can be turned off in the 'Preferences' dialog. Chose the menu 'Window->preferences' and the option 'Install/Update' unselect the 'Automatically select mirrors' option.
- Install new features to Eclipse
- Chose the from the menu:
- 'Help->Software Update'->Find and install' will bring up the 'Install/Update' dialog.
- Select the 'Search for new feature to install' option and click the 'Next' button. This will take you to a new dialog.
- Select wanted site(s).
- Chose the preferred new features to install.
You may chose to install other features from different update sites, for example, C/C++ Development Tools (CDT) from 'http://download.eclipse.org/tools/cdt/releases/callisto'.
Note: By selecting the 'Automatically select mirrors' option the update chose the nearest update server, not necessarily the fastest.
What features and plug-ins that are installed can be verified in the 'Help' menu. Chose 'About Eclipse SDK' and a dialog appears. Examine features and plug-in details by clicking the buttons 'Feature Details' and 'Plug-in Details'.
- Create a new project
- In the tab "Package Explore" right click
- Select New -> Project -> General -> Project, and name the project
- Right click the project and select New -> Example... -> SaveCCM Diagram
- select the newly created project and name the new file
- Import an existing project
- Right click the new project and select Import -> General -> Archive File
- Locate a zip file with a demo example (e.g. comm_w_delay.zip)
- Select the project you want to import (e.g. "Communication w delay")
- To see the architectural view of the system
- Double click the .saveccm_diagram file
- To see the all attributes of a graphical element, select an element and right click, and select Show Properties View. A tab is opened in the lower right windows of Eclipse.
- To see a timed behavior
- To map and generate code for a timed behavior In this step the internal variables of a timed behavior is mapped with ports of a component and the code is generated.
- In the timed behavior view, right click the white background and select "Mapping"
- Fill in the ports to associate with the parameters (* TO DO *)
- In the timed behavior view, right click the white background and select "Generation"
- (A file is generated in the directory "xsta Files")
- Repeat this procedure for all timed behavior of the model
- To generate code for the model
- (Assuming step 5 is completed)
- In the architectural view (i.e. .saveccm_digram) right click the white background and select "Generation"
- (A file is generated in the directory "SAVE")
- To generate code for, and use UPPAAL PORT
- (Assuming step 6 is completed)
- In the architectural view (i.e. .saveccm_digram) right click the white background and select "export to uppaalPort"
- (Three files are generated in the directory "Uppaal Output")
- In the directory "Uppaal Output", right click the .save file and select "Show Uppaal PORT"
- A tab named "Uppaal PORT" should open in the lower right windows in which the system can be simulated and verified.
Eclipse(TM) is a trademark of Eclipse Foundation INC.
While doing work in order to improve or implement new features into SAVE-IDE specific tools and/or additional plugins may be needed. In this section the tools and plug-ins to use is described for each module.
When beeing a part of a big software project it is important that some guidelines is followed for how to managing the source base after changes or adding new code. In SAVE-IDE project the source base resides in a repository at the address:
svn co https://save-ide.svn.sourceforge.net/svnroot/save-ide save-ide. Before you start working with SAVE-IDE you ned tp get a local working base. For details on how to get the source base read thsi page, http://sourceforge.net/svn/?group_id=206364. Normally you check out a module frome the base codeline which is called trunk, browse the repository at http://save-ide.svn.sourceforge.net/viewvc/save-ide/trunk/.
Remember that you only have to check out the module that you will work on. For example, if you want to work on the module
update or checkout do changes, if necessary change the version number according to the applicable guidelines, either general or code line specific. Do not forget to make appropriate changes to the documentation both in the code and the manuals. update create a CHANGELOG entry create a patch dos2unix on the patch file review the patch to ensure that it only contain the intended changes submit patch to tracker commit the changes to the repository, before clicking OK review which files that is comitted. If any unwanted files uncheck them.
save_ArchEdit you must then add
/trunk/save_ArchEdit to your command in order to not get the whole repository.