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