src/GeomTools/GeomTools_Curve2dSet.cdl

   1 -- Created on: 1993-07-19
   2 -- Created by: Remi LEQUETTE
   3 -- Copyright (c) 1993-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   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
  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.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class Curve2dSet from GeomTools
  18
  19         ---Purpose: Stores a set of Curves from Geom2d.
  20
  21 uses
  22     Curve                 from Geom2d,
  23     IndexedMapOfTransient from TColStd,
  24     ProgressIndicator     from Message
  25
  26 raises
  27     OutOfRange from Standard
  28
  29 is
  30
  31     Create returns Curve2dSet from GeomTools;
  32         ---Purpose: Returns an empty set of Curves.
  33
  34     Clear(me : in out)
  35         ---Purpose: Clears the content of the set.
  36     is static;
  37
  38     Add(me : in out; C : Curve from Geom2d) returns Integer
  39         ---Purpose: Incorporate a new Curve in the  set and returns
  40         --          its index.
  41     is static;
  42
  43     Curve2d(me; I : Integer) returns Curve from Geom2d
  44         ---Purpose: Returns the Curve of index <I>.
  45     raises
  46         OutOfRange from Standard
  47     is static;
  48
  49     Index(me; C : Curve from Geom2d) returns Integer
  50         ---Purpose: Returns the index of <L>.
  51     is static;
  52
  53     Dump(me; OS : in out OStream)
  54         ---Purpose: Dumps the content of me on the stream <OS>.
  55     is static;
  56
  57     Write(me; OS : in out OStream)
  58         ---Purpose: Writes the content of  me  on the stream <OS> in a
  59         --          format that can be read back by Read.
  60     is static;
  61
  62     Read(me : in out; IS : in out IStream)
  63         ---Purpose: Reads the content of me from the  stream  <IS>. me
  64         --          is first cleared.
  65         --
  66     is static;
  67
  68     --
  69     --  class methods to write an read curves
  70     --
  71
  72     PrintCurve2d(myclass; C  : Curve from Geom2d;
  73                           OS : in out OStream;
  74                           compact : Boolean = Standard_False);
  75         ---Purpose: Dumps the curve on the stream,  if compact is True
  76         --          use the compact format that can be read back.
  77
  78     ReadCurve2d(myclass; IS : in out IStream;
  79                          C  : in out Curve from Geom2d)
  80     returns IStream;
  81         ---Purpose: Reads the curve  from  the stream.  The  curve  is
  82         --          assumed   to have  been  writtent  with  the Print
  83         --          method (compact = True).
  84         --
  85         ---C++: return &
  86
  87     SetProgress(me : in out; PR : ProgressIndicator from Message);
  88
  89     GetProgress(me) returns ProgressIndicator from Message;
  90
  91 fields
  92
  93     myMap : IndexedMapOfTransient from TColStd;
  94     myProgress : ProgressIndicator from Message;
  95
  96 end Curve2dSet;
  97
  98