be04139eda3a254bc0b198141b0f975c3cd8ff26
[occt.git] / src / Aspect / Aspect_WidthMap.cdl
1 -- Created on: 1993-03-23
2 -- Created by: GG
3 -- Copyright (c) 1993-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 class WidthMap from Aspect inherits TShared from MMgt
23
24         ---Version: 0.0
25
26         ---Purpose: This class defines a WidthMap object.
27         ---Keywords:
28         ---Warning:
29         ---References:
30
31 uses
32         WidthOfLine             from Aspect,
33         WidthMapEntry           from Aspect,
34         SequenceOfWidthMapEntry from Aspect,
35         Length                  from Quantity
36
37 raises
38         BadAccess       from Aspect
39
40 is
41         Create
42         returns mutable WidthMap from Aspect;
43         ---Level: Public
44         ---Purpose: Creates a width map.
45
46         AddEntry (me : mutable; AnEntry : WidthMapEntry from Aspect)
47         ---Level: Public
48         ---Purpose: Adds an entry in the Width map <me>.
49         --  Warning: Raises BadAccess if WidthMap size is exceeded.
50         raises BadAccess from Aspect;
51
52         AddEntry (me : mutable; aStyle : WidthOfLine from Aspect)
53                                         returns Integer from Standard;
54         ---Level: Public
55         ---Purpose: Search an identical line width entry in the width map <me>
56         -- and returns the WidthMapEntry Index if exist.
57         -- Or add a new entry and returns the computed WidthMapEntry index used.
58
59         AddEntry (me : mutable; aStyle : Length from Quantity)
60                                         returns Integer from Standard;
61         ---Level: Public
62         ---Purpose: Search an identical line width entry in the width map <me>
63         -- and returns the WidthMapEntry Index if exist.
64         -- Or add a new entry and returns the computed WidthMapEntry index used.
65
66         Size( me ) returns Integer from Standard is static;
67         ---Level: Public
68         ---Purpose: Returns the Allocated widthmap Size
69  
70         Index( me ; aWidthmapIndex : Integer ) returns Integer from Standard
71         ---Level: Public
72         ---Purpose: Returns the WidthMapEntry.Index of the WidthMap
73         --          at rank <aWidthmapIndex> .
74         raises BadAccess from Aspect is static;
75         ---Trigger: Raises BadAccess if the index less than 1 or
76         --          greater than Size.
77  
78         Entry ( me ;
79                 AnIndex : Integer from Standard )
80         returns WidthMapEntry from Aspect
81         ---Level: Public
82         ---Purpose: Returns the Width map entry with the index <AnIndex>.
83         --  Warning: Raises BadAccess if the index less than 1 or
84         --          greater than Size.
85         raises BadAccess from Aspect is static;
86
87         Dump ( me ) ;
88         ---Level: Internal
89
90 fields
91         mydata : SequenceOfWidthMapEntry from Aspect is protected;
92
93 end WidthMap ;