Files
OCCT/src/Aspect/Aspect_WidthMap.cdl
bugmster 973c2be1e1 0024428: Implementation of LGPL license
The copying permission statements at the beginning of source files updated to refer to LGPL.
Copyright dates extended till 2014 in advance.
2013-12-17 12:42:41 +04:00

89 lines
3.0 KiB
Plaintext

-- Created on: 1993-03-23
-- Created by: GG
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and / or modify it
-- under the terms of the GNU Lesser General Public version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
class WidthMap from Aspect inherits TShared from MMgt
---Version: 0.0
---Purpose: This class defines a WidthMap object.
---Keywords:
---Warning:
---References:
uses
WidthOfLine from Aspect,
WidthMapEntry from Aspect,
SequenceOfWidthMapEntry from Aspect,
Length from Quantity
raises
BadAccess from Aspect
is
Create
returns mutable WidthMap from Aspect;
---Level: Public
---Purpose: Creates a width map.
AddEntry (me : mutable; AnEntry : WidthMapEntry from Aspect)
---Level: Public
---Purpose: Adds an entry in the Width map <me>.
-- Warning: Raises BadAccess if WidthMap size is exceeded.
raises BadAccess from Aspect;
AddEntry (me : mutable; aStyle : WidthOfLine from Aspect)
returns Integer from Standard;
---Level: Public
---Purpose: Search an identical line width entry in the width map <me>
-- and returns the WidthMapEntry Index if exist.
-- Or add a new entry and returns the computed WidthMapEntry index used.
AddEntry (me : mutable; aStyle : Length from Quantity)
returns Integer from Standard;
---Level: Public
---Purpose: Search an identical line width entry in the width map <me>
-- and returns the WidthMapEntry Index if exist.
-- Or add a new entry and returns the computed WidthMapEntry index used.
Size( me ) returns Integer from Standard is static;
---Level: Public
---Purpose: Returns the Allocated widthmap Size
Index( me ; aWidthmapIndex : Integer ) returns Integer from Standard
---Level: Public
---Purpose: Returns the WidthMapEntry.Index of the WidthMap
-- at rank <aWidthmapIndex> .
raises BadAccess from Aspect is static;
---Trigger: Raises BadAccess if the index less than 1 or
-- greater than Size.
Entry ( me ;
AnIndex : Integer from Standard )
returns WidthMapEntry from Aspect
---Level: Public
---Purpose: Returns the Width map entry with the index <AnIndex>.
-- Warning: Raises BadAccess if the index less than 1 or
-- greater than Size.
raises BadAccess from Aspect is static;
Dump ( me ) ;
---Level: Internal
fields
mydata : SequenceOfWidthMapEntry from Aspect is protected;
end WidthMap ;