src/TDataStd/TDataStd_Integer.cdl

   1 -- Created on: 1997-02-06
   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 Integer from TDataStd inherits Attribute from TDF
  24
  25         ---Purpose:  The basis to define an integer attribute.
  26
  27 uses Attribute       from TDF,
  28      Label           from TDF,
  29      GUID            from Standard,
  30      Integer         from Standard,
  31      RelocationTable from TDF
  32
  33 is
  34
  35     ---Purpose: class methods
  36     --          =============
  37
  38     GetID (myclass)
  39         ---C++: return const &
  40         ---Purpose: Returns the GUID for integers.
  41     returns GUID from Standard;
  42
  43     Set (myclass; label : Label from TDF; value : Integer from Standard)
  44     ---Purpose: Finds, or creates, an Integer attribute and sets <value>
  45     --          the Integer  attribute is returned.
  46     returns Integer from TDataStd;
  47
  48     ---Purpose: Integer methods
  49     --          ===============
  50
  51     Set (me : mutable; V : Integer from Standard);
  52
  53     Get (me)
  54     returns Integer from Standard;
  55     ---Purpose: Returns the integer value contained in the attribute.
  56     IsCaptured(me) returns Boolean;
  57         ---Purpose: Returns True if there is a reference on the same label
  58
  59     ---Category: methodes de TDF_Attribute
  60     --           =========================
  61
  62     ID (me)
  63         ---C++: return const &
  64     returns GUID from Standard;
  65
  66     Restore (me: mutable; With : Attribute from TDF);
  67
  68     NewEmpty (me)
  69     returns mutable Attribute from TDF;
  70
  71     Paste (me; Into : mutable Attribute from TDF;
  72                RT   : mutable RelocationTable from TDF);
  73
  74     Dump(me; anOS : in out OStream from Standard)
  75         returns OStream from Standard
  76         is redefined;
  77         ---C++: return &
  78
  79
  80     Create
  81     returns mutable Integer from TDataStd;
  82
  83
  84 fields
  85
  86     myValue : Integer from Standard;
  87
  88 end Integer;