src/TNaming/TNaming_Name.cdl

   1 -- Created on: 1997-03-19
   2 -- Created by: Yves FRICAUD
   3 -- Copyright (c) 1997-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 -- Modified     by  SZY  Wed  Aug  18  1999
  18
  19
  20 class Name from TNaming
  21
  22 uses
  23
  24     NameType         from TNaming,
  25     NamedShape       from TNaming,
  26     ListOfNamedShape from TNaming,
  27     ShapeEnum        from TopAbs,
  28     Orientation      from TopAbs,
  29     Shape            from TopoDS,
  30     Label            from TDF,
  31     LabelMap         from TDF,
  32     RelocationTable  from TDF
  33
  34 is
  35
  36     ---Category: Construction
  37     --           ============
  38
  39     Create returns Name from TNaming;
  40
  41     Type           (me : in out; aType : NameType  from TNaming);
  42
  43     ShapeType      (me : in out; aType : ShapeEnum from TopAbs);
  44
  45     Shape          (me : in out; theShape : Shape from TopoDS);
  46
  47     Append         (me : in out; arg : NamedShape  from TNaming);
  48
  49     StopNamedShape (me : in out; arg : NamedShape  from TNaming);
  50
  51     Index          (me : in out; I : Integer   from Standard);
  52
  53     ContextLabel   (me : in out; theLab : Label from TDF);
  54
  55     Orientation    (me : in out; theOrientation : Orientation from TopAbs);
  56
  57
  58    ---Category: Queriyng
  59    --           ========
  60
  61     Type (me) returns NameType from TNaming;
  62
  63     ShapeType (me)  returns ShapeEnum from TopAbs;
  64
  65     Shape     (me)   returns Shape from TopoDS;
  66
  67     Arguments (me) returns ListOfNamedShape from TNaming;
  68     ---Purpose:
  69     ---C++: return const&
  70
  71     StopNamedShape (me) returns NamedShape from TNaming ;
  72
  73     Index          (me) returns Integer    from Standard;
  74
  75     ContextLabel   (me) returns Label from TDF;
  76     ---C++: return const&
  77
  78     Orientation    (me) returns Orientation from TopAbs;
  79     ---C++: inline
  80     ---C++: return const
  81
  82
  83     ---Category: Resolution
  84     --           ==========
  85
  86     Solve(me;
  87           aLab   : Label        from TDF;
  88           Valid  : LabelMap     from TDF)
  89     returns Boolean from Standard;
  90
  91     Paste (me;
  92            into : in out  Name from TNaming;
  93            RT   : mutable RelocationTable from TDF);
  94
  95 fields
  96
  97     myType      : NameType         from TNaming;
  98     myShapeType : ShapeEnum        from TopAbs;
  99     myArgs      : ListOfNamedShape from TNaming;
 100     myStop      : NamedShape       from TNaming;
 101     myIndex     : Integer          from Standard;
 102     myShape     : Shape            from TopoDS;
 103     myContextLabel : Label         from TDF;
 104     myOrientation  : Orientation   from TopAbs;
 105
 106 end Name;