| 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 | -- |
| d5f74e42 |
8 | -- This library is free software; you can redistribute it and/or modify it under |
| 9 | -- the terms of the GNU Lesser General Public License version 2.1 as published |
| 973c2be1 |
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 | |
| 17 | class MarkMapEntry from Aspect |
| 18 | |
| 19 | ---Version: 0.0 |
| 20 | |
| 21 | ---Purpose: This class defines a markmap entrys. |
| 22 | -- A markmap entry is an association between |
| 23 | -- a MarkerStyle object and an index in the markmap. |
| 24 | ---Keywords: |
| 25 | ---Warning: |
| 26 | ---References: |
| 27 | |
| 28 | uses |
| 29 | MarkerStyle from Aspect |
| 30 | |
| 31 | raises |
| 32 | BadAccess from Aspect |
| 33 | |
| 34 | is |
| 35 | Create |
| 36 | returns MarkMapEntry from Aspect; |
| 37 | ---Level: Public |
| 38 | ---Purpose: Creates an unallocated markmap entry |
| 39 | |
| 40 | Create ( index : Integer from Standard; |
| 41 | style : MarkerStyle from Aspect) |
| 42 | returns MarkMapEntry; |
| 43 | ---Level: Public |
| 44 | ---Purpose: Creates an allocated markmap entry |
| 45 | |
| 46 | Create ( entry : MarkMapEntry from Aspect ) |
| 47 | returns MarkMapEntry |
| 48 | ---Level: Public |
| 49 | ---Purpose: Creates an allocated markmap entry. |
| 50 | -- Warning: Raises error if the markmap entry <entry> |
| 51 | -- is unallocated. |
| 52 | raises BadAccess from Aspect; |
| 53 | |
| 54 | SetValue ( me: in out; index : Integer from Standard; |
| 55 | style : MarkerStyle from Aspect ); |
| 56 | ---Level: Public |
| 57 | ---Purpose: Sets markmap entry value and allocates it. |
| 58 | |
| 59 | SetValue ( me: in out; entry : MarkMapEntry from Aspect); |
| 60 | ---Level: Public |
| 61 | ---Purpose: Sets markmap entry value and allocates it. |
| 62 | ---C++: alias operator = |
| 63 | |
| 64 | SetStyle ( me: in out; Style : MarkerStyle from Aspect ); |
| 65 | ---Level: Public |
| 66 | ---Purpose: Sets the marker style of markmap entry. |
| 67 | |
| 68 | Style ( me ) returns MarkerStyle from Aspect |
| 69 | ---Warning: Raises error if the markmap entry is unallocated . |
| 70 | raises BadAccess from Aspect; |
| 71 | ---C++: return const & |
| 72 | |
| 73 | SetIndex ( me: in out; index : Integer from Standard); |
| 74 | ---Level: Public |
| 75 | ---Purpose: Sets index value of a markmap entry. |
| 76 | |
| 77 | Index ( me ) returns Integer from Standard |
| 78 | ---Level: Public |
| 79 | ---Purpose: Returns index value of a markmap entry. |
| 80 | -- Warning: Raises error if the markmap entry is unallocated . |
| 81 | raises BadAccess from Aspect; |
| 82 | |
| 83 | Free ( me : in out ); |
| 84 | ---Level: Public |
| 85 | ---Purpose: Unallocates the markmap entry. |
| 86 | |
| 87 | IsAllocated ( me ) returns Boolean from Standard; |
| 88 | ---Level: Public |
| 89 | ---Purpose: Returns True if the markmap entry is allocated. |
| 90 | -- Warning: A markmap entry is allocated when the marker and |
| 91 | -- the index is defined. |
| 92 | |
| 93 | Dump( me ) ; |
| 94 | ---Level: Internal |
| 95 | |
| 96 | fields |
| 97 | MyStyle : MarkerStyle from Aspect; |
| 98 | MyIndex : Integer from Standard; |
| 99 | MyStyleIsDef : Boolean from Standard; |
| 100 | MyIndexIsDef : Boolean from Standard; |
| 101 | |
| 102 | end MarkMapEntry from Aspect; |
projects / occt.git / blame