src/TDataStd/TDataStd_NoteBook.cdl

   1 -- Created on: 1997-07-29
   2 -- Created by: Denis PASCAL
   3 -- Copyright (c) 1997-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23 class NoteBook from TDataStd inherits Attribute from TDF
  24
  25         ---Purpose: NoteBook Object attribute
  26
  27
  28 uses Attribute       from TDF,
  29      Label           from TDF,
  30      Real            from TDataStd,
  31      Integer         from TDataStd,
  32      GUID            from Standard,
  33      DataSet         from TDF,
  34      RelocationTable from TDF
  35
  36 is
  37
  38     ---Purpose: class methods
  39     --          =============
  40
  41     Find (myclass; current : Label from TDF; N : in out NoteBook from TDataStd)
  42     ---Purpose: try to retrieve a NoteBook attribute at <current> label
  43     --           or in  fathers  label of  <current>. Returns True  if
  44     --          found and set <N>.
  45     returns Boolean from Standard;
  46
  47     New (myclass; label : Label from TDF)
  48     ---Purpose:  Create  an  enpty   NoteBook attribute,  located  at
  49     --          <label>. Raises if <label> has attribute
  50     returns NoteBook from TDataStd;
  51
  52     GetID (myclass)
  53     ---C++: return const &
  54     returns GUID from Standard;
  55     ---Purpose: NoteBook methods
  56     --          ===============
  57
  58     Create
  59     returns mutable NoteBook from TDataStd;
  60
  61
  62     Append (me : mutable; value  : Real    from Standard;
  63                           isExported : Boolean from Standard = Standard_False)
  64     ---Purpose:  Tool to Create  an  Integer  attribute from  <value>,
  65     --          Insert it in   a  new son  label   of <me>. The   Real
  66     --          attribute is returned.
  67     returns Real from TDataStd;
  68
  69     Append (me : mutable; value  : Integer from Standard;
  70                           isExported : Boolean from Standard = Standard_False)
  71     ---Purpose: Tool to Create  an Real attribute from <value>, Insert
  72     --          it  in a new son label  of <me>. The Integer attribute
  73     --          is returned.
  74     returns Integer from TDataStd;
  75
  76
  77     ---Category: methodes de TDF_Attribute
  78     --           =========================
  79
  80     ID (me)
  81     ---C++: return const &
  82     returns GUID from Standard;
  83
  84     Restore (me: mutable; with : Attribute from TDF);
  85
  86     NewEmpty (me)
  87     returns mutable Attribute from TDF;
  88
  89     Paste (me; into : mutable Attribute from TDF;
  90                RT   : mutable RelocationTable from TDF);
  91
  92     Dump(me; anOS : in out OStream from Standard)
  93         returns OStream from Standard
  94         is redefined;
  95         ---C++: return &
  96
  97 end NoteBook;