Integration of OCCT 6.5.0 from SVN
[occt.git] / src / Aspect / Aspect_TypeMapEntry.cdl
1
2 --
3 -- File:        Aspect_TypeMapEntry.cdl
4 -- Created:     07/09/93
5 -- Author:      GG
6 --
7 ---Copyright:   MatraDatavision 1993
8 --
9
10 class TypeMapEntry from Aspect
11
12         ---Version: 0.0
13
14         ---Purpose: This class defines a typemap entry.
15         --          A typemap entry is an association between
16         --          a LineStyle object and an index in the typemap.
17         ---Keywords:
18         ---Warning:
19         ---References:
20
21 uses
22         LineStyle from Aspect
23
24 raises
25         BadAccess       from Aspect
26
27 is
28         Create
29         returns TypeMapEntry from Aspect;
30         ---Level: Public
31         ---Purpose: Creates an unallocated typemap entry
32         
33         Create ( index : Integer from Standard; 
34                  style : LineStyle from Aspect)
35         returns TypeMapEntry;
36         ---Level: Public
37         ---Purpose: Creates an allocated typemap entry
38
39         Create ( entry : TypeMapEntry from Aspect )
40         returns TypeMapEntry
41         ---Level: Public
42         ---Purpose: Creates an allocated typemap entry.
43         --  Warning: Raises error if the typemap entry <entry>
44         --          is unallocated.
45         raises BadAccess from Aspect;
46
47         SetValue ( me: in out; index : Integer from Standard;
48                                style : LineStyle from Aspect );
49         ---Level: Public
50         ---Purpose: Sets typemap entry value and allocates it.
51  
52         SetValue ( me: in out; entry : TypeMapEntry from Aspect);
53         ---Level: Public
54         ---Purpose: Sets typemap entry value and allocates it.
55         ---C++: alias operator =
56  
57         SetType ( me: in out; Style : LineStyle from Aspect );
58         ---Level: Public
59         ---Purpose: Sets the line style of typemap entry.
60
61         Type ( me ) returns LineStyle from Aspect
62         ---Warning: Raises error if the typemap entry is unallocated .
63         raises BadAccess from Aspect;
64         ---C++: return const & 
65
66         SetIndex ( me: in out; index : Integer from Standard);
67         ---Level: Public
68         ---Purpose: Sets index value of a typemap entry.
69
70         Index ( me ) returns Integer from Standard 
71         ---Level: Public
72         ---Purpose: Returns index value of a typemap entry.
73         --  Warning: Raises error if the typemap entry is unallocated .
74         raises BadAccess from Aspect;
75
76         Free ( me : in out );
77         ---Level: Public
78         ---Purpose: Unallocates the typemap entry.
79
80         IsAllocated ( me ) returns Boolean from Standard;
81         ---Level: Public
82         ---Purpose: Returns True if the typemap entry is allocated.
83         --  Warning: A typemap entry is allocated when the type and
84         --          the index is defined.
85
86         Dump( me ) ;
87         ---Level: Internal
88
89 fields
90         MyType          : LineStyle from Aspect;
91         MyIndex         : Integer from Standard;
92         MyTypeIsDef     : Boolean from Standard;
93         MyIndexIsDef    : Boolean from Standard;
94
95 end TypeMapEntry from Aspect;