0024428: Implementation of LGPL license
[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-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
9 -- under the terms of the GNU Lesser General Public 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 class GeneralModule from RWHeaderSection  inherits GeneralModule from StepData
18         ---Purpose : Defines General Services for HeaderSection Entities
19         --           (Share,Check,Copy; Trace already inherited)
20         --           Depends (for case numbers) of Protocol from HeaderSection
21
22 uses Transient,
23      EntityIterator from Interface,
24      ShareTool      from Interface,
25      Check          from Interface,
26      CopyTool       from Interface
27
28 is
29
30         Create returns mutable GeneralModule from RWHeaderSection;
31         ---Purpose : Creates a GeneralModule
32
33         FillSharedCase (me; CN : Integer; ent : Transient;
34         iter : in out EntityIterator);
35         ---Purpose : Specific filling of the list of Entities shared by an Entity
36         --           <ent>, according to a Case Number <CN> (provided by HeaderSection
37         --           Protocol).
38
39         CheckCase (me; CN : Integer; ent : Transient; shares : ShareTool; ach : in out Check);
40         ---Purpose : Specific Checking of an Entity <ent>
41
42         CopyCase (me; CN : Integer; entfrom : Transient; entto : mutable Transient; TC : in out CopyTool);
43         ---Purpose : Specific Copy ("Deep") from <entfrom> to <entto> (same type)
44         --           by using a CopyTool which provides its working Map.
45         --           Use method Transferred from CopyTool to work
46
47
48         NewVoid (me; CN : Integer; ent : out mutable Transient) returns Boolean;
49
50 end GeneralModule;