Mercurial > hg > ltpda

annotate m-toolbox/html_help/help/ug/gui_gltpda_2_content.html @ 22:b11e88004fca database-connection-manager

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