src/BinTools/BinTools_Curve2dSet.cdl

   1 -- Created on: 2004-05-18
   2 -- Created by: Sergey ZARITCHNY <szy@opencascade.com>
   3 -- Copyright (c) 2004-2014 OPEN CASCADE SAS
   4 --
   5 -- This file is part of Open CASCADE Technology software library.
   6 --
   7 -- This library is free software; you can redistribute it and / or modify it
   8 -- under the terms of the GNU Lesser General Public version 2.1 as published
   9 -- by the Free Software Foundation, with special exception defined in the file
  10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 -- distribution for complete text of the license and disclaimer of any warranty.
  12 --
  13 -- Alternatively, this file may be used under the terms of Open CASCADE
  14 -- commercial license or contractual agreement.
  15
  16 class Curve2dSet from BinTools
  17
  18         ---Purpose: Stores a set of Curves from Geom2d in binary format
  19
  20 uses
  21     Curve from Geom2d,
  22     IndexedMapOfTransient from TColStd
  23
  24 raises
  25     OutOfRange from Standard
  26
  27 is
  28
  29     Create returns Curve2dSet from BinTools;
  30         ---Purpose: Returns an empty set of Curves.
  31
  32     Clear(me : in out)
  33         ---Purpose: Clears the content of the set.
  34     is static;
  35
  36     Add(me : in out; C : Curve from Geom2d) returns Integer
  37         ---Purpose: Incorporate a new Curve in the  set and returns
  38         --          its index.
  39     is static;
  40
  41     Curve2d(me; I : Integer) returns Curve from Geom2d
  42         ---Purpose: Returns the Curve of index <I>.
  43     raises
  44         OutOfRange from Standard
  45     is static;
  46
  47     Index(me; C : Curve from Geom2d) returns Integer
  48         ---Purpose: Returns the index of <L>.
  49     is static;
  50
  51     Dump(me; OS : in out OStream)
  52         ---Purpose: Dumps the content of me on the stream <OS>.
  53     is static;
  54
  55     Write(me; OS : in out OStream)
  56         ---Purpose: Writes the content of  me  on the stream <OS> in a
  57         --          format that can be read back by Read.
  58     is static;
  59
  60     Read(me : in out; IS : in out IStream)
  61         ---Purpose: Reads the content of me from the  stream  <IS>. me
  62         --          is first cleared.
  63         --
  64     is static;
  65
  66     --
  67     --  class methods to write an read curves
  68     --
  69
  70     WriteCurve2d(myclass; C  : Curve from Geom2d;
  71                           OS : in out OStream);
  72         ---Purpose: Dumps the curve on the binary stream, that can be read back.
  73
  74     ReadCurve2d(myclass; IS : in out IStream;
  75                          C  : in out Curve from Geom2d)
  76     returns IStream;
  77         ---Purpose: Reads the curve  from  the stream.  The  curve  is
  78         --          assumed   to have  been  written  with  the Write
  79         --          method.
  80         --
  81         ---C++: return &
  82
  83 fields
  84
  85     myMap : IndexedMapOfTransient from TColStd;
  86
  87 end Curve2dSet;
  88