0023024: Update headers of OCCT files
[occt.git] / src / RWHeaderSection / RWHeaderSection_GeneralModule.cdl
1 -- Created on: 1994-06-16
2 -- Created by: EXPRESS->CDL V0.2 Translator
3 -- Copyright (c) 1994-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22
23
24
25 class GeneralModule from RWHeaderSection  inherits GeneralModule from StepData
26         ---Purpose : Defines General Services for HeaderSection Entities
27         --           (Share,Check,Copy; Trace already inherited)
28         --           Depends (for case numbers) of Protocol from HeaderSection
29
30 uses Transient,
31      EntityIterator from Interface,
32      ShareTool      from Interface,
33      Check          from Interface,
34      CopyTool       from Interface
35
36 is
37
38         Create returns mutable GeneralModule from RWHeaderSection;
39         ---Purpose : Creates a GeneralModule
40
41         FillSharedCase (me; CN : Integer; ent : Transient;
42         iter : in out EntityIterator);
43         ---Purpose : Specific filling of the list of Entities shared by an Entity
44         --           <ent>, according to a Case Number <CN> (provided by HeaderSection
45         --           Protocol).
46
47         CheckCase (me; CN : Integer; ent : Transient; shares : ShareTool; ach : in out Check);
48         ---Purpose : Specific Checking of an Entity <ent>
49
50         CopyCase (me; CN : Integer; entfrom : Transient; entto : mutable Transient; TC : in out CopyTool);
51         ---Purpose : Specific Copy ("Deep") from <entfrom> to <entto> (same type)
52         --           by using a CopyTool which provides its working Map.
53         --           Use method Transferred from CopyTool to work
54
55
56         NewVoid (me; CN : Integer; ent : out mutable Transient) returns Boolean;
57
58 end GeneralModule;