Salome HOME
Implementation of [bos #35140] [EDF] (2023-T1) Memory communication between SHAPER...
[modules/geom.git] / doc / salome / gui / GEOM / input / transfer_data.doc
1 /*!
2
3 \page transfer_data_page Transfer Data
4
5 This operation performs copying of non-topological data
6 from one shape to another. The topology of the destination object
7 will not change, only non-topological data will be transferred
8 (if it is present in the source object). It is possible to transfer
9 the following data with this operation:
10 <ul>
11 <li> <b>Names</b></li>
12 <li> <b>Materials</b></li>
13 </ul>
14
15 To use this operation, select in the Main Menu <b>Operations -> Transfer Data</b>.
16 The following dialog box will appear.
17
18 \image html transfer_data1.png "Transfer Data Dialog"
19
20 In this dialog:
21 <ul>
22 <li> <b>Source Shape</b> is an object that is a source of non-topological data.</li>
23 <li> <b>Destination Shape</b> is a data destination object. </li>
24 <li> <b>Type of detection operation</b> allows choosing how to search sub-shapes of the 
25      <b>Source Shape</b> in the <b>Destination Shape</b>. The data are transferred
26      from these corresponding sub-shapes. The following methods are possible:
27     <ul>
28     <li><b>Get In Place</b> - the current implementation of Get In Place algorithm
29         (default value).</li>
30     <li><b>Get In Place (old)</b> - the old implementation of Get In Place
31         algorithm.</li>
32     <li><b>Get In Place By History</b> - Get In Place By History algorithm.</li>
33     </ul>
34 </li>
35 </ul>
36
37 To copy the data click on \b Apply or <b>Apply and Close</b> button. 
38 It is possible to see how many names and materials are copied as well as
39 the maximum number of names and materials available for copying. This information is
40 provided in the following message box:
41
42 \image html transfer_data2.png "Transfer Data Information"
43
44 <b>TUI Command:</b> <em>geompy.TransferData(ObjectFrom, ObjectTo, FindMethod),</em> 
45 <br> where \em ObjectFrom is a data source object, \em ObjectTo is a
46 destination object and \em FindMethod is a same shape detection method with
47 default value \em GEOM.FSM_GetInPlace.
48
49 Our <b>TUI Scripts</b> provide you with useful example of the use of
50 \ref swig_TransferData "Transfer Data" functionality.
51  
52 */