1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-06 10:36:12 +03:00
occt/src/BinTools/BinTools_LocationSet.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

84 lines
2.6 KiB
Plaintext
Executable File

-- Created on: 2004-06-15
-- Created by: Sergey ZARITCHNY <szy@opencascade.com>
-- Copyright (c) 2004-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 LocationSet from BinTools
---Purpose: The class LocationSet stores a set of location in
-- a relocatable state.
--
-- It can be created from Locations.
--
-- It can create Locations.
uses
Location from TopLoc,
IndexedMapOfLocation from TopLoc
raises
OutOfRange from Standard
is
Create returns LocationSet from BinTools;
---Purpose: Returns an empty set of locations.
Clear(me : in out)
---Purpose: Clears the content of the set.
is static;
Add(me : in out; L : Location from TopLoc) returns Integer
---Purpose: Incorporate a new Location in the set and returns
-- its index.
is static;
Location(me; I : Integer) returns Location from TopLoc
---Purpose: Returns the location of index <I>.
--
---C++: return const &
raises
OutOfRange from Standard
is static;
Index(me; L : Location from TopLoc) returns Integer
---Purpose: Returns the index of <L>.
is static;
NbLocations(me) returns Integer
---Purpose: Returns number of locations.
is static;
Write(me; OS : in out OStream)
---Purpose: Writes the content of me on the stream <OS> in a
-- format that can be read back by Read.
is static;
Read(me : in out; IS : in out IStream)
---Purpose: Reads the content of me from the stream <IS>. me
-- is first cleared.
--
is static;
fields
myMap : IndexedMapOfLocation from TopLoc;
end LocationSet;