src/SALOMEDS/SALOMEDS_StudyPropertiesAttribute.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/ or email : webmaster.salome@opencascade.com
  19 --
  20 --
  21 --  File   : SALOMEDS_StudyPropertiesAttribute.cdl
  22 --  Author : Yves FRICAUD
  23 --  Module : SALOME
  24
  25 class StudyPropertiesAttribute from SALOMEDS inherits Attribute from TDF
  26
  27         ---Purpose:
  28
  29
  30 uses Attribute          from TDF,
  31      Label              from TDF,
  32      GUID               from Standard,
  33      DataSet            from TDF,
  34      RelocationTable    from TDF,
  35      Data               from TDF,
  36      ExtendedString     from TCollection,
  37      HSequenceOfExtendedString from TColStd,
  38      HSequenceOfInteger from TColStd
  39
  40 is
  41
  42
  43     ---Purpose: class methods
  44     --          =============
  45
  46     GetID (myclass)
  47     ---C++: return const &
  48     returns GUID from Standard;
  49
  50     Set (myclass; label : Label from TDF)
  51     returns StudyPropertiesAttribute from SALOMEDS;
  52
  53     ---Purpose: Common methods
  54     --          ============
  55
  56     Create
  57     returns mutable StudyPropertiesAttribute from SALOMEDS;
  58
  59     Init(me: mutable);
  60
  61     SetUserName(me: mutable; theName : ExtendedString from TCollection);
  62     GetCreatorName(me) returns ExtendedString from TCollection;
  63     GetUserNames(me) returns HSequenceOfExtendedString from TColStd;
  64     SetFirstName(me: mutable; theName : ExtendedString from TCollection);
  65
  66     SetModificationDate(me: mutable; theMinute, theHour, theDay, theMonth, theYear : Integer from Standard);
  67     GetCreationDate(me; theMinute, theHour, theDay, theMonth, theYear : out Integer from Standard)
  68     returns Boolean from Standard;
  69     GetModificationDates(me; theMinutes, theHours, theDays, theMonths, theYears : out HSequenceOfInteger from TColStd);
  70
  71     SetCreationMode(me: mutable; theMode : Integer from Standard);
  72     GetCreationMode(me) returns Integer from Standard;
  73
  74     SetModified(me: mutable; theModified : Integer from Standard);
  75     IsModified(me) returns Boolean from Standard;
  76     GetModified(me) returns Integer from Standard;
  77
  78     SetLocked(me: mutable; theLocked : Boolean from Standard);
  79     IsLocked(me) returns Boolean from Standard;
  80     IsLockChanged(me: mutable; theErase : Boolean from Standard) returns Boolean from Standard;
  81
  82     ID (me)
  83         ---C++: return const &
  84     returns GUID from Standard;
  85
  86     Restore (me: mutable; with : Attribute from TDF);
  87
  88     NewEmpty (me)
  89     returns mutable Attribute from TDF;
  90
  91     Paste (me; into : mutable Attribute from TDF;
  92                RT   : mutable RelocationTable from TDF);
  93
  94 fields
  95
  96     myUserName    : HSequenceOfExtendedString from TColStd;
  97     myMinute      : HSequenceOfInteger from TColStd;
  98     myHour        : HSequenceOfInteger from TColStd;
  99     myDay         : HSequenceOfInteger from TColStd;
 100     myMonth       : HSequenceOfInteger from TColStd;
 101     myYear        : HSequenceOfInteger from TColStd;
 102     myMode        : Integer from Standard;
 103     myModified    : Integer from Standard;
 104     myLocked      : Boolean from Standard;
 105     myLockChanged : Boolean from Standard;
 106
 107 end StudyPropertiesAttribute;