doc/salome/gui/input/study_management_chapter.doc

   1 /*!
   2
   3 \page study_management_page Study management
   4
   5 Study is a document within the application, where you can carry out all
   6 operations provided by the SALOME functionality.
   7 This is a certain abstraction layer between actual
   8 document data (probably, remote data available through CORBA) and data
   9 presentation (in the Object Browser). The study is composed of Data
  10 Object instances, combined into a tree-like structure.
  11
  12 All operations with study are available from the \b File menu.
  13
  14 \note SALOME is a single-study application. It means that only one study
  15 can be opened at the moment.
  16
  17 Immediately after the application is launched there is (normally) no active study.
  18 However, you have access to the embedded Python console, that can be used to initialize
  19 a study by means of Python API (see documentation on SALOME KERNEL module for more details).
  20
  21 The following operations are available from the \b File menu:
  22
  23 \image html menu_file.png
  24
  25 As soon as a study is created or loaded from a file or a data server,
  26 additional operations become available from the \b File menu:
  27
  28 \image html studymanagement.png
  29
  30 \b New - creates a new study. The study will be created
  31 with default name \b Study1. If there is an already opened study,
  32 you will be asked to close it before creating new one.
  33
  34 \b Open - allows to open an existing study by browsing for it in a
  35 standard Open File dialog box, choosing the required
  36 *.hdf file and clicking \a Open button.
  37 If there is already opened study, you will be asked to close it
  38 before opening new one.
  39
  40 \b Reopen - reloads the current study from the associated *.hdf file.
  41 This menu command can be used to reverse the study to the latest saved state.
  42
  43 \b Save - saves the current study. Saving a study you also save its layout, i.e. all positions and sizes
  44 of dockable windows. It means that the difference in settings of the
  45 same windows (for example Python console) is possible between
  46 different modules (the same window can have different size and
  47 position when other module is activated). Also each module can
  48 indicate which common windows are necessary for working, and only they
  49 will be displayed when this module is active.
  50
  51 \note If the study hasn't been previously saved, \b Save will
  52 call the standard Save File dialog box where you can enter the name
  53 for your study and save it.
  54
  55 \b Save \b as - allows to save the current study with a new name.
  56 Input a new name for the study in the standard
  57 Search File dialog box and click \a Save button.
  58
  59 \b Close - closes the current study; alternatively closing of the study
  60 can be done by clicking on the cross in the upper right corner of the desktop window.
  61
  62 \note If the study has not been previously saved, you will be prompted
  63 by the following dialog box with several options:
  64
  65 \image html closestudy.png
  66
  67 \b Connect - allows to open an unloaded or created outside GUI study.
  68
  69 \note Connect is available only if there is an opened study on the data server.
  70
  71 \b Disconnect - unloads the current study from the desktop. The study stays opened
  72 in the data server; it can be then reloaded in the same working session
  73 (using \b Connect operation), but if you quit SALOME application, all changes in the
  74 unloaded study can be lost.
  75
  76 \note If the study has not been previously saved, you will be prompted
  77 by the following dialog box with several options:
  78
  79 \image html disconnect_study.png
  80
  81 <b>Dump study</b> - allows to Dump a SALOME Study in one or several
  82 Python scripts. The following dialog box allows to browse for the location and
  83 define the name for a Python file.
  84
  85 \image html dumpstudy.png
  86
  87 <ul>
  88 <li>
  89 <b>Publish in study</b> - if checked in, the component objects created by
  90 Python commands will be published in the created Study when the script
  91 is played, otherwise the objects will not be published in the Study.
  92 </li>
  93 <li>
  94 <b>Save GUI state</b> - if checked in, the current application layout will be
  95 saved in the Python file.
  96 </li>
  97 </ul>
  98 To confirm your choice click \a Save.
  99
 100 <b>Load Script</b> - allows to load a saved Python Script.
 101
 102 \image html loadscript.png
 103
 104 To confirm your choice click \a Open.
 105
 106 <b>Properties</b> - allows to show/edit the properties of the current study.
 107
 108 \image html studyproperties.png
 109
 110 <ul>
 111 <li>\b Author - allows to change the name of the study author.</li>
 112 <li><b> Creation date</b> - gives the date and time of Study creation.</li>
 113 <li>\b Locked - allows to lock the study for modifications.
 114 In case if \b Locked checkbox is checked your study will be locked for any modifications
 115 for all users. Next time you try to edit it, you will see the
 116 following warning message:
 117 \image html lockedstudy.png </li>
 118 <li><b>Modified/Not Modified</b> - allows to see if any modifications have been
 119 introduced into study since its last save. </li>
 120 <li><b>Length units</b> - allows to change the units of the study.</li>
 121 <li>\b Comment - allows to add arbitrary comment for the study.</li>
 122 <li>\b Modifications - allows to  view the list of changes made in the study.
 123 Each record contains the date and time of the
 124 modification and the name of the user, who has introduced it.</li>
 125 <li><b> Stored data </b> - Shows the versions of data currently stored
 126 in the study. Note, that this information does not concern the current
 127 versions of SALOME modules, it shows the version in which the data has been
 128 initially created. If the study is re-saved in the version of SALOME,
 129 different from the initial one, the version information is
 130 highlighted by the red-colored font, which means that the version information
 131 is not actually valid.</li>
 132 </ul>
 133
 134 \b Preferences - allows \ref setting_preferences_page "setting preferences"
 135  applicable to Salome in general and its modules.
 136
 137 <b>Most recently used</b> - contains a list of recently opened
 138 studies, giving the possibility to fast load the required study.
 139
 140 \b Exit - unlike \b Close, closes not only the current, but all opened
 141 Salome studies.
 142
 143 */