0024784: Move documentation in CDL files to proper location
[occt.git] / src / MDataXtd / MDataXtd.cdl
1 -- Created on: 1997-08-07
2 -- Created by: VAUTHIER Jean-Claude 
3 -- Copyright (c) 1997-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
5 --
6 -- This file is part of Open CASCADE Technology software library.
7 --
8 -- This library is free software; you can redistribute it and/or modify it under
9 -- the terms of the GNU Lesser General Public License version 2.1 as published
10 -- by the Free Software Foundation, with special exception defined in the file
11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 -- distribution for complete text of the license and disclaimer of any warranty.
13 --
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
16
17 -- modified     Sergey Zaritchny
18
19
20
21 package MDataXtd 
22
23         ---Purpose: Storage    and  Retrieval  drivers   for modelling
24         --          attributes.   Transient  attributes are defined in
25         --          package TDataStd and persistent one are defined in
26         --          package PDataStd
27
28 uses TDF,
29      PDF,
30      MDF, 
31      CDM,
32      TDataStd, 
33      TDataXtd,
34      Geom,  -- a supprimer des que Translate est poussee dans MgtGeom
35      PGeom  -- a supprimer des que Translate est poussee dans MgtGeom
36
37 is
38
39     ---Category: Storage drivers for TDataXtd attributes
40     --           =======================================
41
42         class ShapeStorageDriver;
43         
44         class PointStorageDriver;
45         
46         class AxisStorageDriver;
47         
48         class PlaneStorageDriver;
49
50         class GeometryStorageDriver;
51
52         class ConstraintStorageDriver;
53         
54         class PlacementStorageDriver;
55         
56         class PatternStdStorageDriver;
57
58  
59     
60     ---Category: Retrieval drivers for PDataXtd attributes
61     --           =========================================
62
63         class ShapeRetrievalDriver;     
64         
65         class PointRetrievalDriver;
66         
67         class AxisRetrievalDriver;
68         
69         class PlaneRetrievalDriver;
70
71         class GeometryRetrievalDriver;
72
73         class ConstraintRetrievalDriver;
74         
75         class PlacementRetrievalDriver;
76         
77         class PatternStdRetrievalDriver;
78
79
80
81     AddStorageDrivers(aDriverSeq : ASDriverHSequence from MDF; theMessageDriver : MessageDriver from CDM);
82         ---Purpose: Adds the attribute storage drivers to <aDriverSeq>.
83
84
85     AddRetrievalDrivers(aDriverSeq : ARDriverHSequence from MDF; theMessageDriver : MessageDriver from CDM);
86         ---Purpose: Adds the attribute retrieval drivers to <aDriverSeq>.
87
88
89     Translate (Geometry : Geometry from Geom)
90         ---Purpose: Method to launch in MgtGeom
91         --           Delete MDataStd_1.cxx
92         --           Modify MDataStd_GeometryStorageDriver::Paste
93     returns Geometry from PGeom;
94
95
96     Translate (Geometry : Geometry from PGeom)
97         ---Purpose : Method to lasunch in MgtGeom
98         --           Delete MDataStd_1.cxx
99         --           Modify MDataStd_GeometryRetrievalDriver::Paste
100     returns Geometry from Geom;
101
102
103     ---Purpose: Translation of TDataXtd enumerations to integer
104     --          ===============================================
105  
106     ConstraintTypeToInteger (e : ConstraintEnum from TDataXtd)
107     returns Integer from Standard;
108
109     IntegerToConstraintType (i : Integer from Standard)
110     returns ConstraintEnum from TDataXtd;     
111     
112     GeometryTypeToInteger (e : GeometryEnum from TDataXtd)
113     returns Integer from Standard;
114
115     IntegerToGeometryType (i : Integer from Standard)
116     returns GeometryEnum from TDataXtd;     
117     
118 end MDataXtd;