0024530: TKMesh - remove unused package IntPoly
[occt.git] / src / StepData / StepData_Described.cdl
CommitLineData
b311480e 1-- Created on: 1997-05-09
2-- Created by: Christian CAILLET
3-- Copyright (c) 1997-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17deferred class Described from StepData inherits TShared from MMgt
18
19 ---Purpose : General frame to describe entities with Description (Simple or
20 -- Complex)
21
22uses CString,
23 Check from Interface, EntityIterator from Interface,
24 Field from StepData, EDescr from StepData, Simple from StepData
25
26raises InterfaceMismatch from Interface
27
28is
29
30 Initialize (descr : EDescr);
31 ---Purpose : Initializes a Described Entity from a Description
32 -- (i.e. puts it in a field ...)
33
34 Description (me) returns EDescr;
35 ---Purpose : Returns the Description used to define this entity
36
37 IsComplex (me) returns Boolean is deferred;
38 ---Purpose : Tells if a described entity is complex
39
40 Matches (me; steptype : CString) returns Boolean is deferred;
41 ---Purpose : Tells if a step type is matched by <me>
42 -- For a Simple Entity : own type or super type
43 -- For a Complex Entity : one of the members
44
45 As (me; steptype : CString) returns mutable Simple is deferred;
46 ---Purpose : Returns a Simple Entity which matches with a Type in <me> :
47 -- For a Simple Entity : me if it matches, else a null handle
48 -- For a Complex Entity : the member which matches, else null
49
50 HasField (me; name : CString) returns Boolean is deferred;
51 ---Purpose : Tells if a Field brings a given name
52
53 Field (me; name : CString) returns Field
54 ---Purpose : Returns a Field from its name; read-only
55 raises InterfaceMismatch is deferred;
56 -- raises if no Field for <name>
57 ---C++ : return const &
58
59 CField (me : mutable; name : CString) returns Field
60 ---Purpose : Returns a Field from its name; read or write
61 raises InterfaceMismatch is deferred;
62 -- raises if no Field for <name>
63 ---C++ : return &
64
65 --
66
67 Check (me; ach : in out Check from Interface) is deferred;
68 ---Purpose : Fills a Check by using its Description
69
70 Shared (me; list : in out EntityIterator from Interface) is deferred;
71 ---Purpose : Fills an EntityIterator with entities shared by <me>
72
73fields
74
75 thedescr : EDescr;
76
77end Described;