0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / XCAFApp / XCAFApp_Application.hxx
1 // Created on: 2000-05-24
2 // Created by: data exchange team
3 // Copyright (c) 2000-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _XCAFApp_Application_HeaderFile
17 #define _XCAFApp_Application_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <TDocStd_Application.hxx>
23 #include <TColStd_SequenceOfExtendedString.hxx>
24 #include <Standard_CString.hxx>
25 class TDocStd_Document;
26
27
28 class XCAFApp_Application;
29 DEFINE_STANDARD_HANDLE(XCAFApp_Application, TDocStd_Application)
30
31 //! Implements an Application for the DECAF documents
32 class XCAFApp_Application : public TDocStd_Application
33 {
34
35 public:
36
37   //! methods from TDocStd_Application
38   //! ================================
39   Standard_EXPORT virtual Standard_CString ResourcesName() Standard_OVERRIDE;
40   
41   //! Set XCAFDoc_DocumentTool attribute
42   Standard_EXPORT virtual void InitDocument (const Handle(TDocStd_Document)& aDoc) const Standard_OVERRIDE;
43   
44   //! Initializes (for the first time) and returns the
45   //! static object (XCAFApp_Application)
46   //! This is the only valid method to get XCAFApp_Application
47   //! object, and it should be called at least once before
48   //! any actions with documents in order to init application
49   Standard_EXPORT static Handle(XCAFApp_Application) GetApplication();
50
51   //! Dumps the content of me into the stream
52   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
53
54   DEFINE_STANDARD_RTTIEXT(XCAFApp_Application,TDocStd_Application)
55
56 protected:
57   
58   Standard_EXPORT XCAFApp_Application();
59 };
60
61 #endif // _XCAFApp_Application_HeaderFile