0024927: Getting rid of "Persistent" functionality -- Storable
[occt.git] / src / Standard / Standard_GUID.cdl
1 -- Created on: 1997-06-19
2 -- Created by: Christophe LEYNADIER
3 -- Copyright (c) 1997-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
5 --
6 -- This file is part of Open CASCADE Technology software library.
7 --
8 -- This library is free software; you can redistribute it and/or modify it under
9 -- the terms of the GNU Lesser General Public License version 2.1 as published
10 -- by the Free Software Foundation, with special exception defined in the file
11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 -- distribution for complete text of the license and disclaimer of any warranty.
13 --
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
16
17 class GUID from Standard
18
19 is
20     Create returns GUID from Standard;
21     
22     Create(aGuid : CString from Standard)
23         returns GUID from Standard;
24     ---Purpose: build a GUID from an ascii string with the
25     --          following format:
26     --          Length : 36 char
27     --          "00000000-0000-0000-0000-000000000000"
28
29     Create(aGuid : ExtString from Standard)
30         returns GUID from Standard;
31     ---Purpose: build a GUID from an unicode string with the
32     --          following format:
33     --          
34     --          "00000000-0000-0000-0000-000000000000"
35
36     
37     Create(a32b : Integer from Standard;
38            a16b1 : ExtCharacter from Standard;
39            a16b2 : ExtCharacter from Standard;
40            a16b3 : ExtCharacter from Standard;
41            a8b1 : Byte from Standard;
42            a8b2 : Byte from Standard;
43            a8b3 : Byte from Standard;
44            a8b4 : Byte from Standard;
45            a8b5 : Byte from Standard;
46            a8b6 : Byte from Standard)
47         returns GUID from Standard;
48         
49     Create(aGuid : UUID from Standard)
50         returns GUID from Standard;
51
52     Create(aGuid : GUID from Standard)
53         returns GUID from Standard;
54
55     ToUUID(me)
56         returns UUID from Standard ;
57
58     ToCString(me; aStrGuid : PCharacter from Standard);
59     ---Purpose: translate the GUID into ascii string
60     --          the aStrGuid is allocated by user.
61     --          the guid have the following format:
62     --          
63     --          "00000000-0000-0000-0000-000000000000"
64       
65     ToExtString(me; aStrGuid : PExtCharacter from Standard);
66     ---Purpose: translate the GUID into unicode string
67     --          the aStrGuid is allocated by user.
68     --          the guid have the following format:
69     --          
70     --          "00000000-0000-0000-0000-000000000000"
71       
72     IsSame(me; uid : GUID from Standard)
73             returns Boolean from Standard;
74     ---C++: alias operator ==      
75  
76     IsNotSame(me; uid : GUID from Standard)
77             returns Boolean from Standard;
78     ---C++: alias operator !=   
79                     
80     Assign(me : out; uid : GUID from Standard);
81     ---C++: alias operator =
82
83     Assign(me : out; uid : UUID from Standard);
84     ---C++: alias operator =
85                     
86     ShallowDump(me; aStream : in out OStream from Standard);
87     ---Purpose: Display the GUID with the following format:
88     --          
89     --          "00000000-0000-0000-0000-000000000000"
90
91     CheckGUIDFormat(myclass; aGuid : CString from Standard)
92         returns Boolean from Standard;
93     ---Purpose: Check the format of a GUID string.
94     --          It checks the size, the position of the '-' and the correct size of fields.
95
96     Hash(me; Upper : Integer)
97     returns Integer;
98     ---Level: Internal
99     ---Purpose: Hash function for GUID.
100     
101     HashCode(myclass ; aguid : GUID from Standard; Upper : Integer)
102     returns Integer;
103     ---Level: Internal
104     ---Purpose: H method used by collections.
105
106     IsEqual(myclass ; string1 : GUID from Standard; 
107             string2 : GUID from Standard)
108     returns Boolean;
109     ---Level: Internal
110     ---Purpose: Returns True  when the two GUID are the same. 
111
112     fields
113
114          my32b : Integer;
115          my16b1 : ExtCharacter;
116          my16b2 : ExtCharacter;
117          my16b3 : ExtCharacter;
118          my8b1 : Byte;
119          my8b2 : Byte;
120          my8b3 : Byte;
121          my8b4 : Byte;
122          my8b5 : Byte;
123          my8b6 : Byte; 
124         
125 end;