src/SALOMEDS/SALOMEDS_StudyPropertiesAttribute.cdl

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