include/opencascade/XCAFApp_Application.hxx

0001 // Created on: 2000-05-24
0002 // Created by: data exchange team
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 _XCAFApp_Application_HeaderFile
0017 #define _XCAFApp_Application_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_Type.hxx>
0021
0022 #include <TDocStd_Application.hxx>
0023 #include <Standard_CString.hxx>
0024
0025
0026 class XCAFApp_Application;
0027 DEFINE_STANDARD_HANDLE(XCAFApp_Application, TDocStd_Application)
0028
0029 //! Implements an Application for the DECAF documents
0030 class XCAFApp_Application : public TDocStd_Application
0031 {
0032
0033 public:
0034
0035   //! methods from TDocStd_Application
0036   //! ================================
0037   Standard_EXPORT virtual Standard_CString ResourcesName() Standard_OVERRIDE;
0038
0039   //! Set XCAFDoc_DocumentTool attribute
0040   Standard_EXPORT virtual void InitDocument (const Handle(CDM_Document)& aDoc) const Standard_OVERRIDE;
0041
0042   //! Initializes (for the first time) and returns the
0043   //! static object (XCAFApp_Application)
0044   //! This is the only valid method to get XCAFApp_Application
0045   //! object, and it should be called at least once before
0046   //! any actions with documents in order to init application
0047   Standard_EXPORT static Handle(XCAFApp_Application) GetApplication();
0048
0049   //! Dumps the content of me into the stream
0050   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
0051
0052   DEFINE_STANDARD_RTTIEXT(XCAFApp_Application,TDocStd_Application)
0053
0054 protected:
0055
0056   Standard_EXPORT XCAFApp_Application();
0057 };
0058
0059 #endif // _XCAFApp_Application_HeaderFile