2014-06-24 14:36:49 +06:00
|
|
|
/*!
|
|
|
|
|
|
|
|
\page reduce_study_page Reduce Study
|
|
|
|
|
2014-10-27 15:05:11 +05:00
|
|
|
It can be sometimes necessary to keep in the study only the objects that
|
2014-06-24 14:36:49 +06:00
|
|
|
present the final result(s) of the design operations and to delete all
|
2014-10-27 15:05:11 +05:00
|
|
|
other objects, which do not contribute to these results.
|
2014-06-24 14:36:49 +06:00
|
|
|
|
2014-10-27 15:05:11 +05:00
|
|
|
This is especially useful when the model is designed using the GUI
|
|
|
|
and it is necessary to generate a simplified "clean" Python dump without "useless" objects
|
|
|
|
at the end of the model construction.
|
2014-06-24 14:36:49 +06:00
|
|
|
|
2014-10-27 15:05:11 +05:00
|
|
|
This feature can be activated by selecting the desirable object(s) in Object
|
|
|
|
Browser or OCC Viewer and calling "Reduce study" context item.
|
2014-06-24 14:36:49 +06:00
|
|
|
|
|
|
|
\image html reduce_study_dialog.png
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
2014-06-24 18:52:22 +06:00
|
|
|
<li><b> Objects to be kept</b> - objects that will be kept in the study after
|
2014-10-27 15:05:11 +05:00
|
|
|
applying reduce study operation. The objects selected by
|
2014-06-24 18:52:22 +06:00
|
|
|
the user are highlighted in bold font.</li>
|
2014-06-24 14:36:49 +06:00
|
|
|
|
2014-06-24 18:52:22 +06:00
|
|
|
<li><b> Objects to be removed</b> - objects that will be deleted.</li>
|
2014-06-24 14:36:49 +06:00
|
|
|
|
2014-10-27 15:05:11 +05:00
|
|
|
\note It is possible to show/hide object(s) in the
|
|
|
|
current Viewer using "eye" icon next to each tree item.
|
|
|
|
ALL objects in the tree can be shown/hidden by clicking the "eye" icon in the head of the tree view.
|
|
|
|
|
|
|
|
<li><b> Intermediate objects</b> group box allows choosing what should be done with the objects that are used to produce the selected object(s):
|
|
|
|
<li><b> Sub-objects</b> group box allows choosing the same operations for
|
|
|
|
sub-objects of the selected object(s).</li>
|
2014-06-24 18:52:22 +06:00
|
|
|
|
2014-06-24 14:36:49 +06:00
|
|
|
<ul>
|
|
|
|
<li>Keep - object(s) will be kept in the study;</li>
|
2014-06-24 18:52:22 +06:00
|
|
|
<li>Unpublish - object(s) will be unpublished (hidden) from the study;</li>
|
|
|
|
<li>Remove - object(s) will be removed from the study. \note Since use of
|
2014-10-27 15:05:11 +05:00
|
|
|
this option can cause a broken Dump Python script, the warning message
|
|
|
|
is shown confirm/reject removing intermediate objects.</li>
|
2014-06-24 14:36:49 +06:00
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
2014-10-27 15:05:11 +05:00
|
|
|
<li><b> Remove empty folders</b> - if this option is checked, all folders,
|
2014-06-24 18:52:22 +06:00
|
|
|
which will become empty after removing unused objects from the study,
|
|
|
|
will be also removed; otherwise, empty folders will be kept.</li>
|
2014-06-24 14:36:49 +06:00
|
|
|
|
2014-10-27 15:05:11 +05:00
|
|
|
<li><b> Soft removal</b> - if this option is checked, the operation will
|
|
|
|
unpublish the redundant objects from the study instead of deleting them.
|
|
|
|
\n So, soft removal keeps all data in the study to give the user a
|
2014-06-24 18:52:22 +06:00
|
|
|
chance to revert this operation using \ref publish_hidden_objects
|
|
|
|
"Publish Objects" dialog box.</li>
|
2014-06-24 14:36:49 +06:00
|
|
|
|
|
|
|
</ul>
|
|
|
|
*/
|