Mercurial > hg > ltpda
comparison m-toolbox/html_help/help/ug/gui_gltpda_2_content.html @ 0:f0afece42f48
Import.
| author | Daniele Nicolodi <nicolodi@science.unitn.it> |
|---|---|
| date | Wed, 23 Nov 2011 19:22:13 +0100 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:f0afece42f48 |
|---|---|
| 1 <p> | |
| 2 The appearance of the main (first) panel is:<br><br> | |
| 3 <img src="images/ltpdagui_1.png" alt="The GUI appearance" border="1"><br><br> | |
| 4 | |
| 5 | |
| 6 <h2>Access and selection control</h2><hr> | |
| 7 In the upper part of the panel is shown the username typed in by the user when the LTPDA GUI was started.<br> | |
| 8 If the login field was left empty the GUI will consider the anonymous '<tt>JohnDoe</tt>' user; the password field in this case | |
| 9 has been ignored, was it empty or not.<br><br> | |
| 10 | |
| 11 This username is used to identify the current user of the system, and it's stored into the annotation of every analysis created | |
| 12 by the GUI, clicking on the '<tt>New model</tt>' button.<br><br> | |
| 13 | |
| 14 Is possible to change the active user clicking on the '<tt>Login/Logout</tt>' button; this is to be used when:<br> | |
| 15 <ul> | |
| 16 <li>The username do not respect the current active user of the system.<br></li> | |
| 17 <li>The username and/or password typed in aren't valid credentials to connect a LTPDA Repository, | |
| 18 and the user wants to submit/retrieve something.<br></li> | |
| 19 <li>The current user is leaving the computer, to prevent other users to submit by mistake personal objects to a | |
| 20 repository with a wrong account; this would make difficult to keep results traceable.<br></li> | |
| 21 </ul> | |
| 22 <br><br> | |
| 23 On the right the GUI shows the currently active model, if the selected model is a valid LTPDA one. 'Valid' LTPDA models are | |
| 24 those created by the GUI, thus containing the short annotation with the author's name, time and date of creation and so on. | |
| 25 If the selected model isn't recognized by the GUI '<tt>None</tt>' will be shown here, and no selection control will be performed | |
| 26 upon what the user clicks inside that model. | |
| 27 <br><br> | |
| 28 | |
| 29 <h2>Analysis control panel</h2><hr><br> | |
| 30 This contains 3 buttons, all devoted to the control of LTPDA Simulink model files. | |
| 31 <ul> | |
| 32 <li>'<b><tt>New model</tt></b>': it creates an empty valid LTPDA Simulink model. The annotation inside will be created | |
| 33 automatically to respect the current user, time and date, IP address, operative system running and MATLAB/LTPDA | |
| 34 versions.<br></li> | |
| 35 <li>'<b><tt>Open model</tt></b>': similarly to the common '<tt>Open</tt>' command in Simulink, this button loads an existing Simulink | |
| 36 file from disk. If the file contains a valid LTPDA model, then the GUI will perform the selection check when it's | |
| 37 selected.<br></li> | |
| 38 <li>'<b><tt>Save model</tt></b>': lets the user to save the currently selected model. Unlike the common '<tt>Save</tt>' command in | |
| 39 Simulink this will prompt the user with the assigned filename (username + time/date of creation) and the predefined | |
| 40 folders for analyses, if any was set in the <tt>ltpda_startup</tt> file. Anyway, the user can freely rename this to | |
| 41 any name, withstanding the common Simulink filename limitations.<br></li> | |
| 42 </ul><br> | |
| 43 | |
| 44 <h2>Data control panel</h2><hr><br> | |
| 45 Containing 9 buttons and the summary of the Input array, this part is devoted to the control of Input objects (i.e., data | |
| 46 created by the user or generated inside a previous analysis run).<br> | |
| 47 <ul> | |
| 48 <li>'<b><tt>Load</tt></b>': to load data from ASCII file (to be converted into an AO), or from .MAT or .XML files.<br> | |
| 49 If the selected MAT or XML file contains any valid LTPDA object, this is imported into the Input array.<br></li> | |
| 50 <li>'<b><tt>Create</tt></b>': <i>Reserved for future use.</i><br></li> | |
| 51 <li>'<b><tt>Edit</tt></b>': <i>Reserved for future use.</i><br></li> | |
| 52 <li>'<b><tt>Remove</tt></b>': to remove the selected object(s) from the Input array. The numbering of the | |
| 53 remaining objects is not altered, to prevent problems in the indexing of objects into the analysis models opened.<br></li> | |
| 54 <li>'<b><tt>Explore</tt></b>': to pass the selected object(s) to the <tt>ltpda_explorer</tt>, to explore them | |
| 55 into an expandable and browsable window.<br></li> | |
| 56 <li>'<b><tt>Export to workspace</tt></b>': to save the selected object(s) into the MATLAB workspace. The name of these objects | |
| 57 will be automatically set.<br></li> | |
| 58 <li>'<b><tt>Clear input</tt></b>': to clear the entire Input array.<br></li> | |
| 59 <li>'<b><tt>Save workspace</tt></b>': even if this button is situated only inside the main panel, the <tt>Save workspace</tt> | |
| 60 function it recalls affects not only the Input array, but the Output array too. It's meant as a solution to capture | |
| 61 the entire current status of the LTPDA GUI, saving it into a .MAT file on disk.<br></li> | |
| 62 <li>'<b><tt>Load workspace</tt></b>': as the <tt>Save workspace</tt> button, it lets the user to load from a .MAT file on | |
| 63 disk the entire saved status of the Input and Output arrays. The loaded contents are appended to the existing arrays | |
| 64 in memory.<br></li> | |
| 65 </ul><br> | |
| 66 <img src="images/ltpdagui_2.png" alt="The info panel" border="1"><br><br> | |
| 67 The central part of the window contains two boxes: on the left a list representing the contents of the Input array, on the right | |
| 68 the details of the object currently selected in the list aside.<br> | |
| 69 Note this will list only LTPDA objects: if any function/block in the analysis produced as output a simple numerical vector or | |
| 70 matrix it won't be visible here.<br><br> | |
| 71 The single click is used to select, to have a look of the details of a single object in the Info panel on the right.<br> | |
| 72 Double clicking on the list will add to the active LTPDA Simulink model (if any is selected) a "Object from list" block, so to | |
| 73 import the object double-clicked in the given model.<br><br> | |
| 74 | |
| 75 <h2>Execution control panel</h2><hr><br> | |
| 76 At the bottom of the window there are: | |
| 77 <ul> | |
| 78 <li>'<b><tt>Maintain intermediate results</tt></b>': enabling this ALL the outputs produced during the analysis (i.e., the | |
| 79 output of every block) will be kept at the end of the analysis itself. This is meant as a way to verify intermediate | |
| 80 results without the need to enable the 'Maintain' option for every single block, but of course should be used with | |
| 81 care, since it will make the Input array very long and populated in a short time.<br> | |
| 82 <li>'<b><tt>Start button</tt></b>': this button starts the execution of the analysis. Till the end of the analysis it will | |
| 83 turn to red. Although the common Simulink '<tt>Start simulation</tt>' button will correctly execute the model, the | |
| 84 user should anytime use just the button enclosed in the GUI, which fulfills many extra purposes; for example, it will | |
| 85 update the Input array list in the main panel, removing all the intermediate results (whenever not differently set), | |
| 86 it will open the progress bar window to represent the analysis proceeding, and it will add terminators in the model | |
| 87 wherever necessary.<br> | |
| 88 </ul> | |
| 89 To make easier the start of the analysis, a direct copy of this button is shown in the upper right corner of the window, | |
| 90 outside the first panel. This is visible from every panel, so it will be possible to start the execution without the need to | |
| 91 open the main panel first.<br> | |
| 92 | |
| 93 </p> | |
| 94 |