src/CDF/CDF_Session.hxx

   1 // Created on: 1997-08-07
   2 // Created by: Jean-Louis Frenkel
   3 // Copyright (c) 1997-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _CDF_Session_HeaderFile
  18 #define _CDF_Session_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Boolean.hxx>
  24 #include <Standard_Transient.hxx>
  25 #include <Standard_Mutex.hxx>
  26 #include <CDM_ApplicationDirectory.hxx>
  27 class CDF_Directory;
  28 class CDF_Application;
  29 class CDF_MetaDataDriver;
  30 class Standard_NoSuchObject;
  31 class Standard_MultiplyDefined;
  32
  33 class CDF_Session;
  34 DEFINE_STANDARD_HANDLE(CDF_Session, Standard_Transient)
  35
  36
  37 class CDF_Session : public Standard_Transient
  38 {
  39
  40 public:
  41
  42
  43   //! returns true if a session has been created.
  44   Standard_EXPORT static Standard_Boolean Exists();
  45
  46   //! Creates a session if it does not exists yet
  47   Standard_EXPORT static Handle(CDF_Session) Create();
  48
  49   //! returns the only one instance of Session
  50   //! that has been created.
  51   Standard_EXPORT static Handle(CDF_Session) CurrentSession();
  52
  53   //! returns true if theApp is added to the session
  54   Standard_EXPORT Standard_Boolean AddApplication(const Handle(CDF_Application)& theApp, const Standard_ThreadId theID);
  55
  56   //! returns true if theApp is added to the session
  57   Standard_EXPORT Standard_Boolean AddApplication(const CDF_Application* theApp, const Standard_ThreadId theID);
  58
  59   //! returns true if theApp is removed from the session
  60   Standard_EXPORT Standard_Boolean RemoveApplication(const Standard_ThreadId theID);
  61
  62   //! returns true if theApp is removed from the session
  63   Standard_EXPORT Standard_Boolean FindApplication(const Standard_ThreadId, Handle(CDF_Application)& theApp) const;
  64
  65
  66 friend class CDF_Application;
  67
  68
  69   DEFINE_STANDARD_RTTIEXT(CDF_Session,Standard_Transient)
  70
  71 protected:
  72
  73   //! Use "Create" session for creation of an instance
  74   CDF_Session();
  75
  76
  77
  78
  79 private:
  80
  81
  82   CDM_ApplicationDirectory myAppDirectory;
  83   Handle(CDF_MetaDataDriver) myMetaDataDriver;
  84 };
  85
  86
  87
  88
  89
  90
  91
  92 #endif // _CDF_Session_HeaderFile