0024530: TKMesh - remove unused package IntPoly
[occt.git] / src / StepData / StepData_UndefinedEntity.cdl
1 -- Created on: 1992-02-11
2 -- Created by: Christian CAILLET
3 -- Copyright (c) 1992-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 UndefinedEntity  from StepData  inherits TShared
18
19     ---Purpose : Undefined entity specific to Step Interface, in which StepType
20     --           is defined at each instance, or is a SubList of another one
21     --           Uses an UndefinedContent, that from Interface is suitable.
22     --           Also an Entity defined by STEP can be "Complex Type" (see
23     --           ANDOR clause in Express).
24
25 uses AsciiString from TCollection, HAsciiString from TCollection,
26      UndefinedContent, Check, CopyTool, EntityIterator,
27      StepReaderData, StepWriter
28
29 is
30
31     Create returns mutable UndefinedEntity;
32     ---Purpose : creates an Unknown entity
33
34     Create (issub : Boolean) returns mutable UndefinedEntity;
35     ---Purpose : Creates a SubList of an Unknown entity : it is an Unknown
36     --           Entity with no Type, but flagged as "SUB" if issub is True
37
38     UndefinedContent (me) returns mutable UndefinedContent;
39     ---Purpose : Returns the UndefinedContent which brings the Parameters
40
41
42     IsSub (me) returns Boolean;
43     ---Purpose : Returns True if an Unndefined Entity is SubPart of another one
44
45     Super (me) returns mutable UndefinedEntity;
46     ---Purpose : Returns the "super-entity" of a sub-part
47
48     IsComplex (me) returns Boolean;
49     ---Purpose : Returns True if <me> defines a Multiple Type Entity (see ANDOR)
50
51     Next (me) returns mutable UndefinedEntity;
52     ---Purpose : For a Multiple Type Entity, returns the Next "Componant"
53     --           For more than two Types, iterative definition (Next->Next...)
54     --           Returns a Null Handle for the end of the List
55
56
57     StepType (me) returns CString;
58     ---Purpose : gives entity type, read from file
59     --           For a Complex Type Entity, gives the first Type read, each
60     --           "Next" gives its "partial" type
61     -- was C++ : return const
62
63     ReadRecord (me : mutable;
64                 SR : StepReaderData; num : Integer; ach : in out Check);
65     ---Purpose : reads data from StepReaderData (i.e. from file), by filling
66     --           StepType and parameters stored in the UndefinedContent
67
68     WriteParams (me; SW : in out StepWriter);
69     ---Purpose : write data to StepWriter, taken from UndefinedContent
70
71     GetFromAnother (me : mutable; other : like me;
72                     TC : in out CopyTool);
73     ---Purpose : reads another UndefinedEntity from StepData
74
75     FillShared     (me; list : in out EntityIterator from Interface);
76     ---Purpose : Fills the list of shared entities
77
78 fields
79
80     thetype : HAsciiString from TCollection;
81     thecont : UndefinedContent;
82     thesub  : Boolean;
83     thenext : UndefinedEntity;  -- for a Multiple Type Entity
84
85 end UndefinedEntity;