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 class XSControl_SignTransferStatus;
0030 DEFINE_STANDARD_HANDLE(XSControl_SignTransferStatus, IFSelect_Signature)
0031
0032 //! This Signatures gives the Transfer Status of an entity, as
0033 //! recorded in a TransferProcess. It can be :
0034 //! - Void : not recorded, or recorded as void with no message
0035 //! (attributes are not taken into account)
0036 //! - Warning : no result, warning message(s), no fail
0037 //! - Fail : no result, fail messages (with or without warning)
0038 //! - Result.. : result, no message (neither warning nor fail)
0039 //! Result.. i.e. Result:TypeName of the result
0040 //! - Result../Warning : result, with warning but no fail
0041 //! - Result../Fail : result, with fail (.e. bad result)
0042 //! - Fail on run : no result yet recorded, no message, but
0043 //! an exception occurred while recording the result
0044 //! (this should not appear and indicates a programming error)
0045 class XSControl_SignTransferStatus : public IFSelect_Signature
0046 {
0047
0048 public:
0049   //! Creates a SignTransferStatus, not initialised
0050   //! it gives nothing (empty string)
0051   Standard_EXPORT XSControl_SignTransferStatus();
0052
0053   //! Creates a SignTransferStatus, which will work on the current
0054   //! TransientProcess brought by the TransferReader (its MapReader)
0055   Standard_EXPORT XSControl_SignTransferStatus(const Handle(XSControl_TransferReader)& TR);
0056
0057   //! Sets a TransferReader to work
0058   Standard_EXPORT void SetReader(const Handle(XSControl_TransferReader)& TR);
0059
0060   //! Sets a precise map to sign entities
0061   //! This definition oversedes the creation with a TransferReader
0062   Standard_EXPORT void SetMap(const Handle(Transfer_TransientProcess)& TP);
0063
0064   //! Returns the TransientProcess used as precised one
0065   //! Returns a Null Handle for a creation from a TransferReader
0066   //! without any further setting
0067   Standard_EXPORT Handle(Transfer_TransientProcess) Map() const;
0068
0069   //! Returns the Reader (if created with a Reader)
0070   //! Returns a Null Handle if not created with a Reader
0071   Standard_EXPORT Handle(XSControl_TransferReader) Reader() const;
0072
0073   //! Returns the Signature for a Transient object, as its transfer
0074   //! status
0075   Standard_EXPORT Standard_CString
0076     Value(const Handle(Standard_Transient)&       ent,
0077           const Handle(Interface_InterfaceModel)& model) const Standard_OVERRIDE;
0078
0079   DEFINE_STANDARD_RTTIEXT(XSControl_SignTransferStatus, IFSelect_Signature)
0080
0081 protected:
0082 private:
0083   Handle(XSControl_TransferReader)  theTR;
0084   Handle(Transfer_TransientProcess) theTP;
0085 };
0086
0087 #endif // _XSControl_SignTransferStatus_HeaderFile