include/opencascade/XSControl_SignTransferStatus.hxx

0001 // Created on: 1998-07-31
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1998-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _XSControl_SignTransferStatus_HeaderFile
0018 #define _XSControl_SignTransferStatus_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IFSelect_Signature.hxx>
0024 class XSControl_TransferReader;
0025 class Transfer_TransientProcess;
0026 class Standard_Transient;
0027 class Interface_InterfaceModel;
0028
0029
0030 class XSControl_SignTransferStatus;
0031 DEFINE_STANDARD_HANDLE(XSControl_SignTransferStatus, IFSelect_Signature)
0032
0033 //! This Signatures gives the Transfer Status of an entity, as
0034 //! recorded in a TransferProcess. It can be :
0035 //! - Void : not recorded, or recorded as void with no message
0036 //! (attributes are not taken into account)
0037 //! - Warning : no result, warning message(s), no fail
0038 //! - Fail : no result, fail messages (with or without warning)
0039 //! - Result.. : result, no message (neither warning nor fail)
0040 //! Result.. i.e. Result:TypeName of the result
0041 //! - Result../Warning : result, with warning but no fail
0042 //! - Result../Fail : result, with fail (.e. bad result)
0043 //! - Fail on run : no result yet recorded, no message, but
0044 //! an exception occurred while recording the result
0045 //! (this should not appear and indicates a programming error)
0046 class XSControl_SignTransferStatus : public IFSelect_Signature
0047 {
0048
0049 public:
0050
0051
0052   //! Creates a SignTransferStatus, not initialised
0053   //! it gives nothing (empty string)
0054   Standard_EXPORT XSControl_SignTransferStatus();
0055
0056   //! Creates a SignTransferStatus, which will work on the current
0057   //! TransientProcess brought by the TransferReader (its MapReader)
0058   Standard_EXPORT XSControl_SignTransferStatus(const Handle(XSControl_TransferReader)& TR);
0059
0060   //! Sets a TransferReader to work
0061   Standard_EXPORT void SetReader (const Handle(XSControl_TransferReader)& TR);
0062
0063   //! Sets a precise map to sign entities
0064   //! This definition oversedes the creation with a TransferReader
0065   Standard_EXPORT void SetMap (const Handle(Transfer_TransientProcess)& TP);
0066
0067   //! Returns the TransientProcess used as precised one
0068   //! Returns a Null Handle for a creation from a TransferReader
0069   //! without any further setting
0070   Standard_EXPORT Handle(Transfer_TransientProcess) Map() const;
0071
0072   //! Returns the Reader (if created with a Reader)
0073   //! Returns a Null Handle if not created with a Reader
0074   Standard_EXPORT Handle(XSControl_TransferReader) Reader() const;
0075
0076   //! Returns the Signature for a Transient object, as its transfer
0077   //! status
0078   Standard_EXPORT Standard_CString Value (const Handle(Standard_Transient)& ent, const Handle(Interface_InterfaceModel)& model) const Standard_OVERRIDE;
0079
0080
0081
0082
0083   DEFINE_STANDARD_RTTIEXT(XSControl_SignTransferStatus,IFSelect_Signature)
0084
0085 protected:
0086
0087
0088
0089
0090 private:
0091
0092
0093   Handle(XSControl_TransferReader) theTR;
0094   Handle(Transfer_TransientProcess) theTP;
0095
0096
0097 };
0098
0099
0100
0101
0102
0103
0104
0105 #endif // _XSControl_SignTransferStatus_HeaderFile