0024530: TKMesh - remove unused package IntPoly
[occt.git] / src / Aspect / Aspect_MarkMap.cdl
CommitLineData
b311480e 1-- Created on: 1995-01-13
2-- Created by: GG
3-- Copyright (c) 1995-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
7fd59977 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
7fd59977 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.
7fd59977 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class MarkMap from Aspect inherits TShared from MMgt
18
19 ---Version: 0.0
20
21 ---Purpose: This class defines a MarkMap object.
22 ---Keywords:
23 ---Warning:
24 ---References:
25uses
26 MarkerStyle from Aspect,
27 MarkMapEntry from Aspect,
28 SequenceOfMarkMapEntry from Aspect
29
30raises
31 BadAccess from Aspect
32
33is
34 Create returns mutable MarkMap from Aspect;
35
36 AddEntry (me : mutable; AnEntry : MarkMapEntry from Aspect)
37 ---Level: Public
38 ---Purpose: Adds an entry in the mark map <me>.
39 -- Warning: Raises BadAccess if MarkMap size is exceeded.
40 raises BadAccess from Aspect;
41
42 AddEntry (me : mutable; aStyle : MarkerStyle from Aspect)
43 returns Integer from Standard;
44 ---Level: Public
45 ---Purpose: Search an identical marker style entry in the mark map <me>
46 -- and returns the MarkMapEntry Index if exist.
47 -- Or add a new entry and returns the computed MarkMapEntry index used.
48
49 Size( me ) returns Integer from Standard is static;
50 ---Level: Public
51 ---Purpose: Returns the Allocated markmap Size
52
53 Index( me ; aMarkmapIndex : Integer ) returns Integer from Standard
54 ---Level: Public
55 ---Purpose: Returns the MarkMapEntry.Index of the MarkMap
56 -- at rank <aMarkmapIndex> .
57 raises BadAccess from Aspect is static;
58 ---Trigger: Raises BadAccess if the index less than 1 or
59 -- greater than Size.
60
61 Dump( me ) ;
62
63 Entry ( me ;
64 AnIndex : Integer from Standard )
65 returns MarkMapEntry from Aspect
66 ---Level: Public
67 ---Purpose: Returns the Mark map entry with the index <AnIndex>.
68 -- Warning: Raises BadAccess if the index less than 1 or
69 -- greater than Size.
70 raises BadAccess from Aspect is static;
71
72fields
73
74 mydata : SequenceOfMarkMapEntry from Aspect is protected;
75
76end MarkMap ;