0024157: Parallelization of assembly part of BO
[occt.git] / src / CDM / CDM_Reference.cdl
1 -- Created on: 1997-10-22
2 -- Created by: Jean-Louis Frenkel
3 -- Copyright (c) 1997-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22 private class Reference from CDM  inherits Transient from Standard
23
24 uses Document from CDM, DocumentPointer from CDM, Application from CDM, MetaData from CDM
25
26 is
27
28     Create(aFromDocument: Document from CDM; aToDocument: Document from CDM; aReferenceIdentifier: Integer from Standard; aToDocumentVersion: Integer from Standard)
29     returns mutable Reference from CDM
30     is private;
31
32     Create(aFromDocument: Document from CDM; aMetaData: MetaData from CDM; aReferenceIdentifier: Integer from Standard; anApplication: Application from CDM; aToDocumentVersion: Integer from Standard; UseStorageConfiguration: Boolean from Standard)
33     returns mutable Reference from CDM
34     is private;
35     
36
37     
38
39     FromDocument(me: mutable) returns Document from CDM;
40
41     ToDocument(me: mutable) returns Document from CDM;
42             
43     ReferenceIdentifier(me: mutable) returns Integer from Standard;
44     
45     
46 ---Category: methods to modifiy the reference.
47
48
49     Update(me: mutable; aMetaData: MetaData from CDM)
50     is private;
51
52     IsUpToDate(me) returns Boolean from Standard
53     is private;
54     ---Purpose: compares the actual document version with the 
55     --          document version at the creation of the reference
56     SetIsUpToDate(me: mutable)
57     is private;
58
59     UnsetToDocument(me: mutable; aMetaData: MetaData from CDM; anApplication: Application from CDM) is private;
60     
61     IsOpened(me) returns Boolean from Standard is private;
62     ---Purpose: returns  true if the  ToDocument has been retrieved
63     --          and opened.
64
65     DocumentVersion(me) returns Integer from Standard;
66     
67     IsReadOnly(me) returns Boolean from Standard;
68
69     Document(me) returns Document from CDM
70     is private;
71
72     MetaData(me) returns MetaData from CDM
73     is private;
74     
75     Application(me) returns Application from CDM
76     is private;
77
78     UseStorageConfiguration(me) returns Boolean from Standard
79     is private;
80     
81     IsInSession(me) returns Boolean from Standard
82     is private;
83     
84     IsStored(me) returns Boolean from Standard
85     is private;
86     
87 fields
88
89     myToDocument: Document from CDM;
90     myFromDocument: DocumentPointer from CDM;
91     myReferenceIdentifier: Integer from Standard;
92     
93     myApplication: Application from CDM;
94     myMetaData: MetaData from CDM;
95     myDocumentVersion: Integer from Standard;    
96     myUseStorageConfiguration: Boolean from Standard;
97 friends class Document from CDM
98 end Reference from CDM;