File: OSD_Disk.hxx

package info (click to toggle)
oce 0.18.3-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 301,548 kB
  • sloc: cpp: 1,190,609; ansic: 67,225; sh: 11,630; tcl: 7,954; cs: 5,221; python: 2,867; java: 1,522; makefile: 342; xml: 292; perl: 37
file content (112 lines) | stat: -rw-r--r-- 2,784 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _OSD_Disk_HeaderFile
#define _OSD_Disk_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Macro.hxx>

#include <TCollection_AsciiString.hxx>
#include <Standard_Integer.hxx>
#include <OSD_Error.hxx>
#include <Standard_CString.hxx>
#include <Standard_Boolean.hxx>
class OSD_OSDError;
class OSD_Path;


//! 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 user's disk quota (in Bytes).
  Standard_EXPORT   Standard_Integer DiskQuota() ;
  
  //! Sets user's disk quota (in Bytes).
  //! Warning: Needs system administrator privilege.
  Standard_EXPORT   void SetDiskQuota (const Standard_Integer QuotaSize) ;
  
  //! Activates user's disk quota
  //! Warning: Needs system administrator privilege.
  Standard_EXPORT   void SetQuotaOn() ;
  
  //! Deactivates user's disk quota
  //! Warning: Needs system administrator privilege.
  Standard_EXPORT   void SetQuotaOff() ;
  
  //! Returns TRUE if an error occurs
  Standard_EXPORT   Standard_Boolean Failed()  const;
  
  //! Resets error counter to zero
  Standard_EXPORT   void Reset() ;
  
  //! Raises OSD_Error
  Standard_EXPORT   void Perror() ;
  
  //! Returns error number if 'Failed' is TRUE.
  Standard_EXPORT   Standard_Integer Error()  const;




protected:





private:



  TCollection_AsciiString DiskName;
  Standard_Integer myQuotaSize;
  OSD_Error myError;


};







#endif // _OSD_Disk_HeaderFile