1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-31 11:15:31 +03:00
occt/src/Aspect/Aspect_MarkMapEntry.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

109 lines
3.4 KiB
Plaintext
Executable File

-- Created on: 1995-01-13
-- Created by: GG
-- Copyright (c) 1995-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
class MarkMapEntry from Aspect
---Version: 0.0
---Purpose: This class defines a markmap entrys.
-- A markmap entry is an association between
-- a MarkerStyle object and an index in the markmap.
---Keywords:
---Warning:
---References:
uses
MarkerStyle from Aspect
raises
BadAccess from Aspect
is
Create
returns MarkMapEntry from Aspect;
---Level: Public
---Purpose: Creates an unallocated markmap entry
Create ( index : Integer from Standard;
style : MarkerStyle from Aspect)
returns MarkMapEntry;
---Level: Public
---Purpose: Creates an allocated markmap entry
Create ( entry : MarkMapEntry from Aspect )
returns MarkMapEntry
---Level: Public
---Purpose: Creates an allocated markmap entry.
-- Warning: Raises error if the markmap entry <entry>
-- is unallocated.
raises BadAccess from Aspect;
SetValue ( me: in out; index : Integer from Standard;
style : MarkerStyle from Aspect );
---Level: Public
---Purpose: Sets markmap entry value and allocates it.
SetValue ( me: in out; entry : MarkMapEntry from Aspect);
---Level: Public
---Purpose: Sets markmap entry value and allocates it.
---C++: alias operator =
SetStyle ( me: in out; Style : MarkerStyle from Aspect );
---Level: Public
---Purpose: Sets the marker style of markmap entry.
Style ( me ) returns MarkerStyle from Aspect
---Warning: Raises error if the markmap entry is unallocated .
raises BadAccess from Aspect;
---C++: return const &
SetIndex ( me: in out; index : Integer from Standard);
---Level: Public
---Purpose: Sets index value of a markmap entry.
Index ( me ) returns Integer from Standard
---Level: Public
---Purpose: Returns index value of a markmap entry.
-- Warning: Raises error if the markmap entry is unallocated .
raises BadAccess from Aspect;
Free ( me : in out );
---Level: Public
---Purpose: Unallocates the markmap entry.
IsAllocated ( me ) returns Boolean from Standard;
---Level: Public
---Purpose: Returns True if the markmap entry is allocated.
-- Warning: A markmap entry is allocated when the marker and
-- the index is defined.
Dump( me ) ;
---Level: Internal
fields
MyStyle : MarkerStyle from Aspect;
MyIndex : Integer from Standard;
MyStyleIsDef : Boolean from Standard;
MyIndexIsDef : Boolean from Standard;
end MarkMapEntry from Aspect;