src/OSD/OSD_Directory.hxx

   1 // Created on: 1992-05-18
   2 // Created by: Stephan GARNAUD (ARM)
   3 // Copyright (c) 1992-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 _OSD_Directory_HeaderFile
  18 #define _OSD_Directory_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <OSD_FileNode.hxx>
  25 class OSD_Path;
  26 class OSD_Protection;
  27
  28
  29 //! Management of directories (a set of directory oriented tools)
  30 class OSD_Directory  : public OSD_FileNode
  31 {
  32 public:
  33
  34   DEFINE_STANDARD_ALLOC
  35
  36
  37   //! Creates Directory object.
  38   //! It is initiliazed to an empty name.
  39   Standard_EXPORT OSD_Directory();
  40
  41   //! Creates Directory object initialized with Name.
  42   Standard_EXPORT OSD_Directory(const OSD_Path& Name);
  43
  44   //! Creates (physically) a directory.
  45   //! When a directory of the same name already exists, no error is
  46   //! returned, and only <Protect> is applied to the existing directory.
  47   //!
  48   //! If Build is used and <me> is instantiated without a name,
  49   //! OSDError is raised.
  50   Standard_EXPORT void Build (const OSD_Protection& Protect);
  51
  52   //! Creates a temporary Directory in current directory.
  53   //! This directory is automatically removed when object dies.
  54   Standard_EXPORT static OSD_Directory BuildTemporary();
  55
  56
  57
  58
  59 protected:
  60
  61
  62
  63
  64
  65 private:
  66
  67
  68
  69
  70
  71 };
  72
  73
  74
  75
  76
  77
  78
  79 #endif // _OSD_Directory_HeaderFile