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