src/SALOMEDS/SALOMEDS_SequenceOfIntegerAttribute.cdl

   1 // Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 // This library is free software; you can redistribute it and/or
   5 // modify it under the terms of the GNU Lesser General Public
   6 // License as published by the Free Software Foundation; either
   7 // version 2.1 of the License.
   8 //
   9 // This library is distributed in the hope that it will be useful
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 // Lesser General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Lesser General Public
  15 // License along with this library; if not, write to the Free Software
  16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 // See http://www.salome-platform.org/
  19 //
  20 --  SALOME SALOMEDS : data structure of SALOME and sources of Salome data server
  21 --
  22 --  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
  23 --  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
  24 --
  25 --  This library is free software; you can redistribute it and/or
  26 --  modify it under the terms of the GNU Lesser General Public
  27 --  License as published by the Free Software Foundation; either
  28 --  version 2.1 of the License.
  29 --
  30 --  This library is distributed in the hope that it will be useful,
  31 --  but WITHOUT ANY WARRANTY; without even the implied warranty of
  32 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  33 --  Lesser General Public License for more details.
  34 --
  35 --  You should have received a copy of the GNU Lesser General Public
  36 --  License along with this library; if not, write to the Free Software
  37 --  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  38 --
  39 --  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  40 --
  41 --
  42 --
  43 --  File   : SALOMEDS_SequenceOfIntegerAttribute.cdl
  44 --  Author : Yves FRICAUD
  45 --  Module : SALOME
  46
  47 class SequenceOfIntegerAttribute from SALOMEDS inherits Attribute from TDF
  48
  49         ---Purpose:
  50
  51
  52 uses Attribute         from TDF,
  53      Label             from TDF,
  54      GUID              from Standard,
  55      HSequenceOfInteger from TColStd,
  56      DataSet           from TDF,
  57      RelocationTable   from TDF,
  58      AttributeSequence from TDF,
  59      Data              from TDF,
  60      Comment           from TDataStd
  61
  62
  63 is
  64
  65
  66     ---Purpose: class methods
  67     --          =============
  68
  69     GetID (myclass)
  70     ---C++: return const &
  71     returns GUID from Standard;
  72
  73     Set (myclass; label : Label from TDF)
  74     ---Purpose: Find, or create a Comment attribute and set the string.
  75     --          the Comment attribute is returned.
  76     returns SequenceOfIntegerAttribute from SALOMEDS;
  77
  78     ---Purpose: Comment methods
  79     --          ============
  80
  81     Create
  82     returns mutable SequenceOfIntegerAttribute from SALOMEDS;
  83
  84     ---Category: IntegerArray methods
  85     --          ===============
  86
  87     Assign(me : mutable; other : HSequenceOfInteger from TColStd);
  88     ---Purpose: Initialize the inner sequence by other one
  89
  90     ChangeValue (me : mutable; Index, Value : Integer from Standard);
  91     ---Purpose: Sets  the   <Index>th  element  of   the  sequence to <Value>
  92
  93     Add (me : mutable; value : Integer from Standard);
  94     ---Purpose: Add  new value
  95
  96     Value (me : mutable; Index : Integer from Standard) returns Integer;
  97     ---Purpose: Value of index
  98
  99     Remove (me : mutable; Index : Integer from Standard);
 100     ---Purpose: Remove element on index <Index>
 101
 102     Length (me : mutable) returns Integer;
 103     ---Purpose: Returns length of sequence
 104
 105
 106
 107     ID (me)
 108         ---C++: return const &
 109     returns GUID from Standard;
 110
 111     Restore (me: mutable; with : Attribute from TDF);
 112
 113     NewEmpty (me)
 114     returns mutable Attribute from TDF;
 115
 116     Paste (me; into : mutable Attribute from TDF;
 117                RT   : mutable RelocationTable from TDF);
 118
 119 fields
 120
 121     myValue : HSequenceOfInteger from TColStd;
 122
 123 end SequenceOfIntegerAttribute;