include/opencascade/OSD_Directory.hxx

0001 // Created on: 1992-05-18
0002 // Created by: Stephan GARNAUD (ARM)
0003 // Copyright (c) 1992-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _OSD_Directory_HeaderFile
0018 #define _OSD_Directory_HeaderFile
0019
0020 #include <OSD_FileNode.hxx>
0021
0022 //! Management of directories (a set of directory oriented tools)
0023 class OSD_Directory : public OSD_FileNode
0024 {
0025 public:
0026   //! Creates a temporary Directory in current directory.
0027   //! This directory is automatically removed when object dies.
0028   Standard_EXPORT static OSD_Directory BuildTemporary();
0029
0030 public:
0031   //! Creates Directory object.
0032   //! It is initialized to an empty name.
0033   Standard_EXPORT OSD_Directory();
0034
0035   //! Creates Directory object initialized with theName.
0036   Standard_EXPORT OSD_Directory(const OSD_Path& theName);
0037
0038   //! Creates (physically) a directory.
0039   //! When a directory of the same name already exists, no error is
0040   //! returned, and only <Protect> is applied to the existing directory.
0041   //!
0042   //! If Build is used and <me> is instantiated without a name,
0043   //! OSDError is raised.
0044   Standard_EXPORT void Build(const OSD_Protection& Protect);
0045 };
0046
0047 #endif // _OSD_Directory_HeaderFile