src/TDataStd/TDataStd_BooleanList.cdl

   1 -- Created on: 2007-05-29
   2 -- Created by: Vlad Romashko
   3 -- Copyright (c) 2007-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 under
   8 -- the terms of the GNU Lesser General Public License 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 BooleanList from TDataStd inherits Attribute from TDF
  17
  18     ---Purpose: Contains a list of bolleans.
  19
  20 uses
  21
  22     Attribute from TDF,
  23     GUID from Standard,
  24     Label from TDF,
  25     RelocationTable from TDF,
  26     ListOfByte from TDataStd
  27
  28 is
  29
  30     ---Purpose: Static methods
  31     --          ==============
  32
  33     GetID (myclass)
  34     ---C++: return const &
  35     ---Purpose: Returns the ID of the list of booleans attribute.
  36     returns GUID from Standard;
  37
  38     Set (myclass; label : Label from TDF)
  39     ---Purpose: Finds or creates a list of boolean values attribute.
  40     returns BooleanList from TDataStd;
  41
  42
  43     ---Category: BooleanList methods
  44     --           ===================
  45
  46     Create
  47     returns BooleanList from TDataStd;
  48
  49     IsEmpty (me)
  50     returns Boolean from Standard;
  51
  52     Extent (me)
  53     returns Integer from Standard;
  54
  55     Prepend (me : mutable;
  56              value : Boolean from Standard);
  57
  58     Append (me : mutable;
  59             value : Boolean from Standard);
  60
  61     Clear (me : mutable);
  62
  63     First (me)
  64     returns Boolean from Standard;
  65
  66     Last (me)
  67     returns Boolean from Standard;
  68
  69     List (me)
  70     ---C++: return const &
  71     ---Purpose: 1 - means TRUE,
  72     --          0 - means FALSE.
  73     returns ListOfByte from TDataStd;
  74
  75
  76     ---Category: Methodes of TDF_Attribute
  77     --           =========================
  78
  79     ID (me)
  80     ---C++: return const &
  81     returns GUID from Standard;
  82
  83     Restore (me: mutable; With : Attribute from TDF);
  84
  85     NewEmpty (me)
  86     returns Attribute from TDF;
  87
  88     Paste (me; Into : Attribute from TDF;
  89                RT   : RelocationTable from TDF);
  90
  91     Dump(me; anOS : in out OStream from Standard)
  92     returns OStream from Standard
  93     is redefined;
  94     ---C++: return &
  95
  96
  97 fields
  98
  99     myList : ListOfByte from TDataStd;
 100
 101
 102 end BooleanList;