1 // Created on: 2004-11-23
2 // Created by: Pavel TELKOV
3 // Copyright (c) 2004-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 // The original implementation Copyright: (C) RINA S.p.A
18 #ifndef TObj_Application_HeaderFile
19 #define TObj_Application_HeaderFile
21 #include <TDocStd_Application.hxx>
22 #include <TObj_Common.hxx>
23 #include <Message_Gravity.hxx>
24 #include <Message_Messenger.hxx>
25 #include <TColStd_SequenceOfExtendedString.hxx>
28 //! This is a base class for OCAF based TObj models
29 //! with declared virtual methods
31 class TObj_Application : public TDocStd_Application
34 //! Returns static instance of the application
35 Standard_EXPORT static Handle(TObj_Application) GetInstance();
37 //! Returns reference to associated messenger handle
38 Handle(Message_Messenger) &Messenger() { return myMessenger; }
45 //! Saving the OCAF document to a file
46 Standard_EXPORT virtual Standard_Boolean SaveDocument
47 (const Handle(TDocStd_Document)& theSourceDoc,
48 const TCollection_ExtendedString& theTargetFile);
50 //! Loading the OCAF document from a file
51 Standard_EXPORT virtual Standard_Boolean LoadDocument
52 (const TCollection_ExtendedString& theSourceFile,
53 Handle(TDocStd_Document)& theTargetDoc);
55 //! Create the OCAF document from scratch
56 virtual Standard_EXPORT Standard_Boolean CreateNewDocument
57 (Handle(TDocStd_Document)& theDoc,
58 const TCollection_ExtendedString& theFormat);
60 //! Signal error during Load or Save
61 //! Default imiplementation is empty
62 virtual Standard_EXPORT void ErrorMessage
63 (const TCollection_ExtendedString &theMsg,
64 const Message_Gravity theLevel);
66 //! Signal error during Load or Save
67 //! Default imiplementation invoke previous declaration with 0
68 virtual void ErrorMessage
69 (const TCollection_ExtendedString &theMsg)
70 { ErrorMessage( theMsg, Message_Alarm ); }
73 //! Sets the verbose flag, meaning that load/save models should show
74 //! CPU and elapsed times
75 void SetVerbose (const Standard_Boolean isVerbose)
76 { myIsVerbose = isVerbose; }
78 //! Returns the verbose flag
79 Standard_Boolean IsVerbose () const
80 { return myIsVerbose; }
84 * Redefined OCAF methods
87 //! Return name of resource (i.e. "TObj")
88 virtual Standard_EXPORT Standard_CString ResourcesName() Standard_OVERRIDE;
95 //! Constructor is protected. Use method GetInstance() method to obtain
96 //! the static instance of the object (or derive your own application)
97 Standard_EXPORT TObj_Application();
104 Standard_Boolean myIsError; //!< error flag
105 Standard_Boolean myIsVerbose; //!< verbose flag
106 Handle(Message_Messenger) myMessenger; //!< messenger
110 DEFINE_STANDARD_RTTIEXT(TObj_Application,TDocStd_Application)
114 //! Define handle class
115 DEFINE_STANDARD_HANDLE(TObj_Application,TDocStd_Application)