include/opencascade/STEPCAFControl_ExternFile.hxx

0001 // Created on: 2000-09-28
0002 // Created by: Andrey BETENEV
0003 // Copyright (c) 2000-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _STEPCAFControl_ExternFile_HeaderFile
0017 #define _STEPCAFControl_ExternFile_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <IFSelect_ReturnStatus.hxx>
0022 #include <Standard_Boolean.hxx>
0023 #include <TDF_Label.hxx>
0024 #include <Standard_Transient.hxx>
0025 class XSControl_WorkSession;
0026 class TCollection_HAsciiString;
0027
0028 //! Auxiliary class serving as container for data resulting
0029 //! from translation of external file
0030 class STEPCAFControl_ExternFile : public Standard_Transient
0031 {
0032
0033 public:
0034   //! Creates an empty structure
0035   Standard_EXPORT STEPCAFControl_ExternFile();
0036
0037   void SetWS(const occ::handle<XSControl_WorkSession>& WS);
0038
0039   occ::handle<XSControl_WorkSession> GetWS() const;
0040
0041   void SetLoadStatus(const IFSelect_ReturnStatus stat);
0042
0043   IFSelect_ReturnStatus GetLoadStatus() const;
0044
0045   void SetTransferStatus(const bool isok);
0046
0047   bool GetTransferStatus() const;
0048
0049   void SetWriteStatus(const IFSelect_ReturnStatus stat);
0050
0051   IFSelect_ReturnStatus GetWriteStatus() const;
0052
0053   void SetName(const occ::handle<TCollection_HAsciiString>& name);
0054
0055   occ::handle<TCollection_HAsciiString> GetName() const;
0056
0057   void SetLabel(const TDF_Label& L);
0058
0059   TDF_Label GetLabel() const;
0060
0061   DEFINE_STANDARD_RTTIEXT(STEPCAFControl_ExternFile, Standard_Transient)
0062
0063 private:
0064   occ::handle<XSControl_WorkSession>    myWS;
0065   IFSelect_ReturnStatus                 myLoadStatus;
0066   bool                                  myTransferStatus;
0067   IFSelect_ReturnStatus                 myWriteStatus;
0068   occ::handle<TCollection_HAsciiString> myName;
0069   TDF_Label                             myLabel;
0070 };
0071
0072 #include <STEPCAFControl_ExternFile.lxx>
0073
0074 #endif // _STEPCAFControl_ExternFile_HeaderFile