42cf5bc1 |
1 | // Created on: 1998-07-31 |
2 | // Created by: Christian CAILLET |
3 | // Copyright (c) 1998-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 | #ifndef _XSControl_SignTransferStatus_HeaderFile |
18 | #define _XSControl_SignTransferStatus_HeaderFile |
19 | |
20 | #include <Standard.hxx> |
21 | #include <Standard_Type.hxx> |
22 | |
23 | #include <IFSelect_Signature.hxx> |
24 | #include <Standard_CString.hxx> |
25 | class XSControl_TransferReader; |
26 | class Transfer_TransientProcess; |
27 | class Standard_Transient; |
28 | class Interface_InterfaceModel; |
29 | |
30 | |
31 | class XSControl_SignTransferStatus; |
32 | DEFINE_STANDARD_HANDLE(XSControl_SignTransferStatus, IFSelect_Signature) |
33 | |
34 | //! This Signatures gives the Transfer Status of an entity, as |
35 | //! recorded in a TransferProcess. It can be : |
36 | //! - Void : not recorded, or recorded as void with no message |
37 | //! (attributes are not taken into account) |
38 | //! - Warning : no result, warning message(s), no fail |
39 | //! - Fail : no result, fail messages (with or without warning) |
40 | //! - Result.. : result, no message (neither warning nor fail) |
41 | //! Result.. i.e. Result:TypeName of the result |
42 | //! - Result../Warning : result, with warning but no fail |
43 | //! - Result../Fail : result, with fail (.e. bad result) |
44 | //! - Fail on run : no result yet recorded, no message, but |
45 | //! an exception occurred while recording the result |
46 | //! (this should not appear and indicates a programming error) |
47 | class XSControl_SignTransferStatus : public IFSelect_Signature |
48 | { |
49 | |
50 | public: |
51 | |
52 | |
53 | //! Creates a SignTransferStatus, not initialised |
54 | //! it gives nothing (empty string) |
55 | Standard_EXPORT XSControl_SignTransferStatus(); |
56 | |
57 | //! Creates a SignTransferStatus, which will work on the current |
58 | //! TransientProcess brought by the TransferReader (its MapReader) |
59 | Standard_EXPORT XSControl_SignTransferStatus(const Handle(XSControl_TransferReader)& TR); |
60 | |
61 | //! Sets a TransferReader to work |
62 | Standard_EXPORT void SetReader (const Handle(XSControl_TransferReader)& TR); |
63 | |
64 | //! Sets a precise map to sign entities |
65 | //! This definition oversedes the creation with a TransferReader |
66 | Standard_EXPORT void SetMap (const Handle(Transfer_TransientProcess)& TP); |
67 | |
68 | //! Returns the TransientProcess used as precised one |
69 | //! Returns a Null Handle for a creation from a TransferReader |
70 | //! without any further setting |
71 | Standard_EXPORT Handle(Transfer_TransientProcess) Map() const; |
72 | |
73 | //! Returns the Reader (if created with a Reader) |
74 | //! Returns a Null Handle if not created with a Reader |
75 | Standard_EXPORT Handle(XSControl_TransferReader) Reader() const; |
76 | |
77 | //! Returns the Signature for a Transient object, as its transfer |
78 | //! status |
79104795 |
79 | Standard_EXPORT Standard_CString Value (const Handle(Standard_Transient)& ent, const Handle(Interface_InterfaceModel)& model) const Standard_OVERRIDE; |
42cf5bc1 |
80 | |
81 | |
82 | |
83 | |
92efcf78 |
84 | DEFINE_STANDARD_RTTIEXT(XSControl_SignTransferStatus,IFSelect_Signature) |
42cf5bc1 |
85 | |
86 | protected: |
87 | |
88 | |
89 | |
90 | |
91 | private: |
92 | |
93 | |
94 | Handle(XSControl_TransferReader) theTR; |
95 | Handle(Transfer_TransientProcess) theTP; |
96 | |
97 | |
98 | }; |
99 | |
100 | |
101 | |
102 | |
103 | |
104 | |
105 | |
106 | #endif // _XSControl_SignTransferStatus_HeaderFile |