Test for 0022778: Bug in BRepMesh
[occt.git] / src / XSControl / XSControl_SignTransferStatus.cdl
1 -- Created on: 1998-07-31
2 -- Created by: Christian CAILLET
3 -- Copyright (c) 1998-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
23 class SignTransferStatus  from XSControl    inherits Signature  from IFSelect
24
25     ---Purpose : This Signatures gives the Transfer Status of an entity, as
26     --           recorded in a TransferProcess. It can be :
27     --           - Void : not recorded, or recorded as void with no message
28     --             (attributes are not taken into account)
29     --           - Warning : no result, warning message(s), no fail
30     --           - Fail : no result, fail messages (with or without warning)
31     --           - Result.. : result, no message (neither warning nor fail)
32     --             Result.. i.e. Result:TypeName of the result
33     --           - Result../Warning : result, with warning but no fail
34     --           - Result../Fail : result, with fail (.e. bad result)
35     --           - Fail on run : no result yet recorded, no message, but
36     --             an exception occurred while recording the result
37     --             (this should not appear and indicates a programming error)
38
39 uses CString, Transient, InterfaceModel,
40      TransientProcess, TransferReader
41
42 is
43
44     Create returns mutable SignTransferStatus;
45     ---Purpose : Creates a SignTransferStatus, not initialised
46     --           it gives nothing (empty string)
47
48     Create (TR : TransferReader) returns mutable SignTransferStatus;
49     ---Purpose : Creates a SignTransferStatus, which will work on the current
50     --           TransientProcess brought by the TransferReader (its MapReader)
51
52     SetReader (me : mutable; TR : TransferReader);
53     ---Purpose : Sets a TransferReader to work
54
55     SetMap (me : mutable; TP : TransientProcess);
56     ---Purpose : Sets a precise map to sign entities
57     --           This definition oversedes the creation with a TransferReader
58
59     Map    (me) returns TransientProcess;
60     ---Purpose : Returns the TransientProcess used as precised one
61     --           Returns a Null Handle for a creation from a TransferReader
62     --           without any further setting
63
64     Reader (me) returns TransferReader;
65     ---Purpose : Returns the Reader (if created with a Reader)
66     --           Returns a Null Handle if not created with a Reader
67
68
69     Value (me; ent : any Transient; model : InterfaceModel) returns CString;
70     ---Purpose : Returns the Signature for a Transient object, as its transfer
71     --           status
72
73 fields
74  
75     theTR : TransferReader;
76     theTP : TransientProcess;
77  
78 end SignTransferStatus;