summaryrefslogtreecommitdiff
path: root/inc/OSD_Disk.hxx
blob: 72d1f768cbb2597fcc5c44d556139601bde6f5d7 (plain)
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
113
114
115
116
117
118
119
120
121
122
// 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

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _TCollection_AsciiString_HeaderFile
#include <TCollection_AsciiString.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _OSD_Error_HeaderFile
#include <OSD_Error.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class OSD_OSDError;
class OSD_Path;


//! Disk management <br>
class OSD_Disk  {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  //! Creates a disk object. <br>
//!          This is used only when a class contains a Disk field. <br>
//!          By default, its name is initialized to current working disk. <br>
  Standard_EXPORT   OSD_Disk();
  //! Initializes the object Disk with the disk name <br>
//!          associated to the OSD_Path. <br>
  Standard_EXPORT   OSD_Disk(const OSD_Path& Name);
  //! Initializes the object Disk with <PathName>. <br>
//!          <PathName> specifies any file within the mounted <br>
//!          file system. <br>
//!          Example : OSD_Disk myDisk ("/tmp") <br>
//!                    Initializes a disk object with the mounted <br>
//!                    file associated to /tmp. <br>
  Standard_EXPORT   OSD_Disk(const Standard_CString PathName);
  //! Returns disk name of <me>. <br>
  Standard_EXPORT     OSD_Path Name() const;
  //! Instantiates <me> with <Name>. <br>
  Standard_EXPORT     void SetName(const OSD_Path& Name) ;
  //! Returns total disk capacity in 512 bytes blocks. <br>
  Standard_EXPORT     Standard_Integer DiskSize() ;
  //! Returns free available 512 bytes blocks on disk. <br>
  Standard_EXPORT     Standard_Integer DiskFree() ;
  //! Returns user's disk quota (in Bytes). <br>
  Standard_EXPORT     Standard_Integer DiskQuota() ;
  //! Sets user's disk quota (in Bytes). <br>
//!  Warning: Needs system administrator privilege. <br>
  Standard_EXPORT     void SetDiskQuota(const Standard_Integer QuotaSize) ;
  //! Activates user's disk quota <br>
//!  Warning: Needs system administrator privilege. <br>
  Standard_EXPORT     void SetQuotaOn() ;
  //! Deactivates user's disk quota <br>
//!  Warning: Needs system administrator privilege. <br>
  Standard_EXPORT     void SetQuotaOff() ;
  //! Returns TRUE if an error occurs <br>
  Standard_EXPORT     Standard_Boolean Failed() const;
  //! Resets error counter to zero <br>
  Standard_EXPORT     void Reset() ;
  //! Raises OSD_Error <br>
  Standard_EXPORT     void Perror() ;
  //! Returns error number if 'Failed' is TRUE. <br>
  Standard_EXPORT     Standard_Integer Error() const;





protected:





private:



TCollection_AsciiString DiskName;
Standard_Integer myQuotaSize;
OSD_Error myError;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif