Changes between Version 2 and Version 3 of LabassertUserGuide


Ignore:
Timestamp:
05/06/09 09:45:33 (15 years ago)
Author:
pierre
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • LabassertUserGuide

    v2 v3  
    11= Labassert User Guide =
    2 
    3 Reference:
    4 ESA/ESTEC contract n°21166/07/NL/JK -8 Jan. 2008
     2Reference: ESA/ESTEC contract n°21166/07/NL/JK -8 Jan. 2008
    53
    64''Written by: Jérôme Legrand on 20 Nov. 2008 [[BR]] Checked by: Pierre Dissaux on 21 Nov. 2008''
    75
    8 EUROPEAN SPACE AGENCY CONTRACT REPORT
    9 [[BR]]The work described in this report was done under ESA contract. Responsibility for the contents resides in the author or organisation that prepared it.
    10 
    11 Ellidiss Technologies :[[BR]]
    12 [http://www.ellidiss.com www.ellidiss.com][[BR]]
    13 24 quai de la douane, 29200 Brest, France[[BR]]
    14 Tel. +33 (0) 298 451 870[[BR]]
     6EUROPEAN SPACE AGENCY CONTRACT REPORT  [[BR]]The work described in this report was done under ESA contract. Responsibility for the contents resides in the author or organisation that prepared it.
     7
     8Ellidiss Technologies :[[BR]] [http://www.ellidiss.com www.ellidiss.com][[BR]] 24 quai de la douane, 29200 Brest, France[[BR]] Tel. +33 (0) 298 451 870[[BR]]
    159
    1610== Table Of Content ==
    17 
    18  1. [wiki:UserGuide#a1.Installation Installation]
    19  2.  [wiki:UserGuide#a2.ApplicationsDescription Applications Description]
     11 1. [wiki:LabassertUserGuide#a1.Installation Installation]
     12 1. [wiki:UserGuide#a2.ApplicationsDescription Applications Description]
    2013   a. [wiki:UserGuide#a2.1Launcher Launcher]
    2114     i. [wiki:UserGuide#a2.1.1.Screenshots Screenshots]
    22    b. [wiki:UserGuide#a2.2FunctionalView Functional View]
     15   a. [wiki:UserGuide#a2.2FunctionalView Functional View]
    2316     i. [wiki:UserGuide#a2.2.1.Screenshots Screenshots]
    24      ii. [wiki:UserGuide#a2.2.2.Filemenudescription File Menu Description]
    25      iii. [wiki:UserGuide#a2.2.3.EditMenuDescription Edit Menu Description]
    26      iv. [wiki:UserGuide#a2.2.4.MenuDescription “?” Menu Description]
    27    c. [wiki:UserGuide#a2.3InterfaceView Interface View]
     17     i. [wiki:UserGuide#a2.2.2.Filemenudescription File Menu Description]
     18     i. [wiki:UserGuide#a2.2.3.EditMenuDescription Edit Menu Description]
     19     i. [wiki:UserGuide#a2.2.4.MenuDescription “?” Menu Description]
     20   a. [wiki:UserGuide#a2.3InterfaceView Interface View]
    2821     i. [wiki:UserGuide#a2.3.1Screenshots Screenshots]
    29      ii. [wiki:UserGuide#a2.3.2FileMenuDescription File Menu Description]
    30      iii. [wiki:UserGuide#a2.3.3EditMenuDescription Edit Menu Description]
    31      iv. [wiki:UserGuide#a2.3.4ToolsMenuDescription Tools Menu Description]
    32      v. [wiki:UserGuide#a2.3.5MenuDescription “?” Menu Description]
    33    d. [wiki:UserGuide#a2.4DeploymentView Deployment View]
     22     i. [wiki:UserGuide#a2.3.2FileMenuDescription File Menu Description]
     23     i. [wiki:UserGuide#a2.3.3EditMenuDescription Edit Menu Description]
     24     i. [wiki:UserGuide#a2.3.4ToolsMenuDescription Tools Menu Description]
     25     i. [wiki:UserGuide#a2.3.5MenuDescription “?” Menu Description]
     26   a. [wiki:UserGuide#a2.4DeploymentView Deployment View]
    3427     i. [wiki:UserGuide#a2.4.1Screenshots Screenshots]
    35      ii. [wiki:UserGuide#a2.4.2FileMenuDescription File Menu Description]
    36      iii. [wiki:UserGuide#a2.4.3EditMenuDescription Edit Menu Description]
    37      iv. [wiki:UserGuide#a2.4.4ToolsMenuDescription Tools Menu Description]
    38      v. [wiki:UserGuide#a2.4.5MenuDescription “?” Menu Description]
    39  3. [wiki:UserGuide#a3.Tutorial Tutorial]
     28     i. [wiki:UserGuide#a2.4.2FileMenuDescription File Menu Description]
     29     i. [wiki:UserGuide#a2.4.3EditMenuDescription Edit Menu Description]
     30     i. [wiki:UserGuide#a2.4.4ToolsMenuDescription Tools Menu Description]
     31     i. [wiki:UserGuide#a2.4.5MenuDescription “?” Menu Description]
     32 1. [wiki:UserGuide#a3.Tutorial Tutorial]
    4033   a. [wiki:UserGuide#a3.1FunctionalViewEditor Functional View Editor]
    41    b. [wiki:UserGuide#a3.2InterfaceViewEditor Interface View Editor]
    42    c. [wiki:UserGuide#a3.3DeploymentViewEditor Deployment View Editor]
    43 
     34   a. [wiki:UserGuide#a3.2InterfaceViewEditor Interface View Editor]
     35   a. [wiki:UserGuide#a3.3DeploymentViewEditor Deployment View Editor]
    4436
    4537== 1. Installation ==
    46 
    4738Labassert 1.0 is available on Windows and Linux. Its installation requires no specific platform dependent procedure. The only action that may be required is to uncompress the archive with the appropriate utility if the distribution was provided as a zip or tar.gz file.
    4839
    … …  
    5041
    5142An uncompressed distribution of Labassert 1.0 contains the following files:
     43
    5244 * labassert.exe: Windows executable file.
    5345 * Labassert.bin: Linux executable file.
    … …  
    5648 * documentation directory: contains this file and the Labassert study report.
    5749
    58 The Labassert software is a deliverable of an ESA funded study. As thus its distribution and use rules follow the General Clauses and Conditions for ESA Contracts. Please contact ESA or Ellidiss representative for further information about licensing topics. 
     50The Labassert software is a deliverable of an ESA funded study. As thus its distribution and use rules follow the General Clauses and Conditions for ESA Contracts. Please contact ESA or Ellidiss representative for further information about licensing topics.
    5951
    6052Ellidiss Technologies can provide technical support to users of the Labassert tool. Please use the following address to send technical or commercial inquires: labassert@ellidiss.com
    6153
    6254== 2. Applications Description ==
    63 
    6455=== 2.1 Launcher ===
    6556The launcher is used to open the functional, the interface and the deployment view editors.
    … …  
    6960
    7061=== 2.2 Functional View ===
    71 
    7262The Functional View Editor manages the applicative functions that can be referred within the Interface View.
    7363
    … …  
    8171[[Image(htdocs:UserGuide/img2.png)]]
    8272
    83 
    8473==== 2.2.2. File menu description ====
    85 
    8674 * New Library : create a new functional view.
    8775 * Open Library : load an existing functional view (.lfv extension).
    … …  
    9078 * Load Data View : load a data view (data type from this view is then available for parameters interface creation).
    9179 * Quit : close the application.
     80
    9281==== 2.2.3.  Edit Menu Description ====
    93 
    9482 * New Function : create a function (functions appear in “Functions” notebook).
    9583 * Delete Function : delete the selected function.
    … …  
    9886 * New Interface : create an interface (interfaces appear in “interfaces” notebook).
    9987 * Delete Interface : delete the selected interface.
    100  * New Parameter : add a parameter to an interface. 
     88 * New Parameter : add a parameter to an interface.
    10189 * Delete Parameter : remove a parameter from an interface.
     90
    10291==== 2.2.4. “?” Menu Description ====
    103 
    10492 * About : about the Interface View Editor.
    10593 * Help : application description and accelerators available.
    … …  
    132120 * New RI : create a Required Interface on a Container or a Function.
    133121 * New Connection : create a connection between two objects.
    134  * Edit Properties : if an object is selected, open a dialog box to edit its properties. 
     122 * Edit Properties : if an object is selected, open a dialog box to edit its properties.
    135123 * Delete Selection : if an object is selected, remove this object from the diagram.
    136124 * Copy : if objects are selected, copy the selection.
    … …  
    143131 * Generate Interface View : generate the AADL file of the current interface view.
    144132 * Stood :
    145   * Set Execution Path : define the actual location of Stood executable on the system
    146   * Open In Stood : create a Stood model and open Stood
    147   * Generate Interface View : use Stood AADL code generator to generate the Interface View.
    148   * Generate Concurrency View : use Stood AADL code generator and ASSERT Vertical Transformation to generate the Concurrency View.
    149  * Navigation Panel : open the navigation panel in order to scroll and zoom the diagram. 
     133   * Set Execution Path : define the actual location of Stood executable on the system
     134   * Open In Stood : create a Stood model and open Stood
     135   * Generate Interface View : use Stood AADL code generator to generate the Interface View.
     136   * Generate Concurrency View : use Stood AADL code generator and ASSERT Vertical Transformation to generate the Concurrency View.
     137 * Navigation Panel : open the navigation panel in order to scroll and zoom the diagram.
    150138 * Option : launch Interface View Editor option dialog box.
    151139
    … …  
    179167 * Add Function : create a Function on a Partition (an Interface View file containing function(s) has to be open).
    180168 * New Bus : create a Bus on the work zone.
    181  * New Processor Interface : create a Processor Interface on a Processor. 
     169 * New Processor Interface : create a Processor Interface on a Processor.
    182170 * New Connection : create a connection between a Bus and a Processor/Processor Interface.
    183  * Edit Properties : if an object is selected, open a dialog box to edit its properties. 
     171 * Edit Properties : if an object is selected, open a dialog box to edit its properties.
    184172 * Delete Selection : if an object is selected, remove this object from the diagram.
    185173 * Copy : if objects are selected, copy the selection.
    … …  
    190178==== 2.4.4 Tools Menu Description ====
    191179 * Generate Deployment View : generate the AADL file corresponding to the current deployment view.
    192  * Navigation Panel : open the navigation panel in order to scroll and zoom the diagram. 
     180 * Navigation Panel : open the navigation panel in order to scroll and zoom the diagram.
    193181 * Option : launch Deployment View Editor option dialog box.
    194182
    … …  
    201189
    202190=== 3.1 Functional View Editor ===
    203 
    204191 1. Launch the Functional View Editor.
    205  2. Load a '''Data View''' (File → Load Data View):[[BR]]
    206  AADL representation of the Data View files must exist in the workspace. They are usually generated by the Asn2aadlPlus tool. However, a simplistic version of an AADL Data View can be created with any text editor for the purpose of the tutorial. Its contents should be the following:
     192 1. Load a '''Data View''' (File → Load Data View):[[BR]] AADL representation of the Data View files must exist in the workspace. They are usually generated by the Asn2aadlPlus tool. However, a simplistic version of an AADL Data View can be created with any text editor for the purpose of the tutorial. Its contents should be the following:
    207193
    208194{{{
    … …  
    215201END Tutorial_Types;
    216202}}}
    217 
    218  3. Create a '''Function''' named “Calculator” (Edit → New Function) :
    219 [[Image(htdocs:UserGuide/img5.png)]]
     203 3. Create a '''Function''' named “Calculator” (Edit → New Function) :[[Image(htdocs:UserGuide/img5.png)]]
    220204
    221205 4. Click on the “Interfaces” tab.
    222  5. Create 4 '''Interfaces''' named “Add”, “Sub”, “Mul” and “Div” with same attributes (Edit → New Interface) :
    223 [[Image(htdocs:UserGuide/img6.png)]]
    224 
    225  6. For each interfaces, create 3 parameters [[BR]]
    226  (Select the interface and click on Edit → New Parameter) :
     206 4. Create 4 '''Interfaces''' named “Add”, “Sub”, “Mul” and “Div” with same attributes (Edit → New Interface) :[[Image(htdocs:UserGuide/img6.png)]]
     207
     208 6. For each interfaces, create 3 parameters [[BR]] (Select the interface and click on Edit → New Parameter) :
     209
    227210 * o1 : direction “in”, type “Float” and protocol “NATIVE”.
    228211 * o2 : direction “in”, type “Float” and protocol “NATIVE”.
    229  * r : direction “out”, type “Float” and protocol “NATIVE”.
    230 [[Image(htdocs:UserGuide/img7.png)]]
    231 
    232 Note : the newly created parameters shall appear on the right table application.
     212 * r : direction “out”, type “Float” and protocol “NATIVE”.[[Image(htdocs:UserGuide/img7.png)]]
     213
     214Note : the newly created parameters shall appear on the right table application.
    233215
    234216 7. Click on the “Functions” tab.
    235  8. Select the “Calculator” '''Function''' and add the interfaces (Edit → Add Interface) :
    236 [[Image(htdocs:UserGuide/img8.png)]]
    237 
    238  9. Finally, save the current library (File → Save Library) :
    239 [[Image(htdocs:UserGuide/img9.png)]]
     217 7. Select the “Calculator” '''Function''' and add the interfaces (Edit → Add Interface) :[[Image(htdocs:UserGuide/img8.png)]]
     218
     219 9. Finally, save the current library (File → Save Library) :[[Image(htdocs:UserGuide/img9.png)]]
    240220
    241221Note : in the save as dialog box, a default name is proposed for the file : the previously given library name with the “.lfv” extension (Calc.lfv in our example).
    242222
    243223=== 3.2 Interface View Editor ===
    244 
    245224 1. Launch the Interface View Editor.
    246  2. Load the previous '''Functional View''' (File → Load Functional View) : “Calc.lfv” file.
    247  3. Create a '''Container''' named “Time” (Edit → New Container or right mouse button contextual menu New Container entry) :
    248 [[Image(htdocs:UserGuide/img10.png)]]
    249 
    250  4. Create a '''Function''' named “Convert” into the “Time” '''Container''' (Edit → New Function or right mouse button contextual menu New Function entry) :
    251 [[Image(htdocs:UserGuide/img11.png)]]
     225 1. Load the previous '''Functional View''' (File → Load Functional View) : “Calc.lfv” file.
     226 1. Create a '''Container''' named “Time” (Edit → New Container or right mouse button contextual menu New Container entry) :[[Image(htdocs:UserGuide/img10.png)]]
     227
     228 4. Create a '''Function''' named “Convert” into the “Time” '''Container''' (Edit → New Function or right mouse button contextual menu New Function entry) :[[Image(htdocs:UserGuide/img11.png)]]
    252229
    253230 5. Create 3 '''Provided Interfaces''' on the “Convert” '''Function''' (Edit → New PI or right mouse button contextual menu New PI entry) :
     231
    254232 * Day_To_Sec : kind “sporadic”, Inter-arrival time “100”, deadline “5” and “ms” unit.
    255233 * Hour_To_Sec : kind “sporadic”, Inter-arrival time “100”, deadline “5” and “ms” unit.
    … …  
    258236[[Image(htdocs:UserGuide/img12.png)]]
    259237
    260  6. Create 1 '''Required Interfaces''' on the “Convert” '''Function''' (Edit → New RI or right mouse button contextual menu New RI entry) :
     238 6. Create 1 '''Required Interfaces''' on the “Convert” '''Function''' (Edit → New RI or right mouse button contextual menu New RI entry) :
     239
    261240 * “Mul” : choose the operation “Mul” in the combo box.
    262241
    … …  
    264243
    265244 7. Connect all '''Provided Interface Implementation''' to the “Mul” '''Required''' Interface.  In order to create a connection between 2 objects, you have to :
     245
    266246 * Click on Edit → New Connection menu or right mouse button contextual menu New Connection entry or push the “shift” key (don't release the key until the connection has been created).
    267247 * Select the first object by pushing the left mouse button (don't release the button).
    … …  
    270250[[Image(htdocs:UserGuide/img14.png)]]
    271251
    272 Notes :
     252Notes :
     253
    273254 * A connection can be created only between item which have the same parent or have a child-parent relationship.
    274255 * There is a real time connection creation consistency check, when a connection can be created, mouse cursor turns into a crossbar.
    275256 * There is an automatic interface(s) creation facility when 2 objects are connected : in our example, a '''Required Interface''' is automatically created on the '''Provided Interface Implementation'''.
    276257
    277  8. Create 1''' Required Interfaces''' on the “Convert” '''Function'''  and connect all '''Provided Interface Implementation''' to it :
     258 8. Create 1''' Required Interfaces''' on the “Convert” '''Function'''  and connect all '''Provided Interface Implementation''' to it :
     259
    278260 * “Result” : leave the operation field blank.
    279261
    … …  
    285267
    286268 10. Create a “IO” '''Container''' and in this container create 2 '''Functions''', “Input” and “Output”.
    287  11. Create a “sporadic” '''Provided Interface''' named “get_result” on the “Output” '''Function'''.
    288  12. Connect the “Input” '''Function''' to “Day_To_Sec” '''Provided Interface''' and the “get_result” '''Provided Interface''' to the “result” '''Required Interface'''.
    289 
     269 10. Create a “sporadic” '''Provided Interface''' named “get_result” on the “Output” '''Function'''.
     270 10. Connect the “Input” '''Function''' to “Day_To_Sec” '''Provided Interface''' and the “get_result” '''Provided Interface''' to the “result” '''Required Interface'''.
    290271
    291272[[Image(htdocs:UserGuide/img17.png)]]
    292273
    293274 13. Save the current interface view as “Time_Conversion.liv” (File → Save).
    294  14. Double left click on a '''Provided Interface Implementation''' or select Tools → Edit Functional View. A functional view is opened with all the functions and Function's interfaces (open and created in the '''Interface View''') :
     275 13. Double left click on a '''Provided Interface Implementation''' or select Tools → Edit Functional View. A functional view is opened with all the functions and Function's interfaces (open and created in the '''Interface View''') :
    295276
    296277[[Image(htdocs:UserGuide/img18.png)]]
    … …  
    298279Note : this new library can be edited and save for further use.
    299280
    300  15.Generate the '''AADL''' file “Time_Conversion.aadl” (Tools → Generate Interface View). You can check the consistency of the result.
     281  15.Generate the '''AADL''' file “Time_Conversion.aadl” (Tools → Generate Interface View). You can check the consistency of the result.
    301282
    302283=== 3.3 Deployment View Editor ===
    303 
    304284 1. Launch the Deployment View Editor.
    305  2. Load the previous '''Interface View''' (File → Load Interface View) : “Time_Conversion.liv” file.
    306  3. Create 2 '''Processors'''  (Edit → New Processor or right mouse button contextual menu New Processor entry) :
     285 1. Load the previous '''Interface View''' (File → Load Interface View) : “Time_Conversion.liv” file.
     286 1. Create 2 '''Processors'''  (Edit → New Processor or right mouse button contextual menu New Processor entry) :
    307287
    308288 * cpu1 : type “pentium”, implementation name “others”, processor location “127.0.0.1” and execution platform “Native”.
    309289 * cpu2 : type “athlon”, implementation name “others”, processor location “127.0.0.2” and execution platform “Native”.
    310290
    311 
    312291[[Image(htdocs:UserGuide/img19.png)]]
    313292
    … …  
    317296
    318297 5. Create 2 '''Processor Interfaces''' (Edit → New Processor Interface or right mouse button contextual menu New Processor Interface entry) :
     298
    319299 * port_cpu1 on “cpu1” '''Processor''' : interface bus required “VME”.
    320300 * port_cpu2 on “cpu2” '''Processor''' : interface bus required “VME”.
    321  
    322  And connect them to the bus (same process as Interface View Editor).
     301
     302  And connect them to the bus (same process as Interface View Editor).
    323303
    324304[[Image(htdocs:UserGuide/img21.png)]]
    … …  
    327307
    328308 6. Create 2 '''Partitions''' (Edit → New Partition or right mouse button contextual menu New Partition entry) :
     309
    329310 * A1 in “cpu1” '''Processor''' : type “A1”, implementation name “others” and  leave port number empty.
    330311 * A2 in “cpu2” '''Processor''' : type “A2”, implementation name “others” and  leave port number empty.
    … …  
    337318
    338319 8. Save the current deployment view as “Deployment1.ldv” (File → Save).
    339  9. Generate the '''AADL''' file “Deployment1.aadl” (Tools → Generate Deployment View). You can check the consistency of the result.
    340  10. For one '''Interface View''', one can have several '''Deployment View'''. Remove the previously added '''Functions''' (select a '''Function''' or a group of '''Functions''' and File → Delete Selection or right mouse button contextual menu Delete Selection entry ).
     320 8. Generate the '''AADL''' file “Deployment1.aadl” (Tools → Generate Deployment View). You can check the consistency of the result.
     321 8. For one '''Interface View''', one can have several '''Deployment View'''. Remove the previously added '''Functions''' (select a '''Function''' or a group of '''Functions''' and File → Delete Selection or right mouse button contextual menu Delete Selection entry ).
    341322
    342323Note : to select a group of items, left clic in an blank space (don't release the button), and release the left mouse button when all items you want to select are in the selection box.
    … …  
    348329[[Image(htdocs:UserGuide/img25.png)]]
    349330
    350 12. Save the current deployment view as “Deployment2.ldv”.[[BR]]
    351 13. Generate the '''AADL''' file “Deployment2.aadl”. You can check the consistency of the result.
    352 
    353 
    354 Ellidiss Technologies :[[BR]]
    355 [http://www.ellidiss.com www.ellidiss.com][[BR]]
    356 24 quai de la douane, 29200 Brest, France[[BR]]
    357 Tel. +33 (0) 298 451 870[[BR]]
    358 [[Image(htdocs:logoEllidiss.png)]]
     33112. Save the current deployment view as “Deployment2.ldv”.[[BR]] 13. Generate the '''AADL''' file “Deployment2.aadl”. You can check the consistency of the result.
     332
     333Ellidiss Technologies :[[BR]] [http://www.ellidiss.com www.ellidiss.com][[BR]] 24 quai de la douane, 29200 Brest, France[[BR]] Tel. +33 (0) 298 451 870[[BR]] [[Image(htdocs:logoEllidiss.png)]]