0030924: Coding - incorrect header in file OSD_ThreadPool.hxx

[occt.git] / src / OSD / OSD_Disk.hxx

// Created on: 1992-05-27
// Created by: Stephan GARNAUD (ARM)
// Copyright (c) 1992-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _OSD_Disk_HeaderFile
#define _OSD_Disk_HeaderFile

#include <TCollection_AsciiString.hxx>
#include <OSD_Error.hxx>
#include <OSD_Path.hxx>

//! Disk management (a set of disk oriented tools)
class OSD_Disk 
{
public:

  DEFINE_STANDARD_ALLOC

  //! Creates a disk object.
  //! This is used only when a class contains a Disk field.
  //! By default, its name is initialized to current working disk.
  Standard_EXPORT OSD_Disk();
  
  //! Initializes the object Disk with the disk name
  //! associated to the OSD_Path.
  Standard_EXPORT OSD_Disk(const OSD_Path& Name);
  
  //! Initializes the object Disk with <PathName>.
  //! <PathName> specifies any file within the mounted
  //! file system.
  //! Example : OSD_Disk myDisk ("/tmp")
  //! Initializes a disk object with the mounted
  //! file associated to /tmp.
  Standard_EXPORT OSD_Disk(const Standard_CString PathName);
  
  //! Returns disk name of <me>.
  Standard_EXPORT OSD_Path Name() const;
  
  //! Instantiates <me> with <Name>.
  Standard_EXPORT void SetName (const OSD_Path& Name);
  
  //! Returns total disk capacity in 512 bytes blocks.
  Standard_EXPORT Standard_Integer DiskSize();
  
  //! Returns free available 512 bytes blocks on disk.
  Standard_EXPORT Standard_Integer DiskFree();
  
  //! Returns TRUE if an error occurs
  Standard_Boolean Failed() const { return myError.Failed(); }

  //! Resets error counter to zero
  void Reset() { myError.Reset(); }

  //! Raises OSD_Error
  void Perror() { myError.Perror(); }

  //! Returns error number if 'Failed' is TRUE.
  Standard_Integer Error() const { return myError.Error(); }

private:

  TCollection_AsciiString myDiskName;
  OSD_Error myError;

};

#endif // _OSD_Disk_HeaderFile