OSD_Disk Class Reference

Disk management (a set of disk oriented tools) More...

#include <OSD_Disk.hxx>

Public Member Functions
	OSD_Disk ()
	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. More...
	OSD_Disk (const OSD_Path &Name)
	Initializes the object Disk with the disk name associated to the OSD_Path. More...
	OSD_Disk (const Standard_CString PathName)
	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. More...
OSD_Path	Name () const
	Returns disk name of <me>. More...
void	SetName (const OSD_Path &Name)
	Instantiates <me> with <Name>. More...
Standard_Integer	DiskSize ()
	Returns total disk capacity in 512 bytes blocks. More...
Standard_Integer	DiskFree ()
	Returns free available 512 bytes blocks on disk. More...
Standard_Integer	DiskQuota ()
	Returns user's disk quota (in Bytes). More...
void	SetDiskQuota (const Standard_Integer QuotaSize)
	Sets user's disk quota (in Bytes). Warning: Needs system administrator privilege. More...
void	SetQuotaOn ()
	Activates user's disk quota Warning: Needs system administrator privilege. More...
void	SetQuotaOff ()
	Deactivates user's disk quota Warning: Needs system administrator privilege. More...
Standard_Boolean	Failed () const
	Returns TRUE if an error occurs. More...
void	Reset ()
	Resets error counter to zero. More...
void	Perror ()
	Raises OSD_Error. More...
Standard_Integer	Error () const
	Returns error number if 'Failed' is TRUE. More...

Detailed Description

Disk management (a set of disk oriented tools)

Constructor & Destructor Documentation

OSD_Disk() [1/3]

OSD_Disk::OSD_Disk

(

)

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.

OSD_Disk() [2/3]

OSD_Disk::OSD_Disk

(

const OSD_Path &

Name

)

Initializes the object Disk with the disk name associated to the OSD_Path.

OSD_Disk() [3/3]

OSD_Disk::OSD_Disk

(

const Standard_CString

PathName

)

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.

Member Function Documentation

DiskFree()

Standard_Integer OSD_Disk::DiskFree

(

)

Returns free available 512 bytes blocks on disk.

DiskQuota()

Standard_Integer OSD_Disk::DiskQuota

(

)

Returns user's disk quota (in Bytes).

DiskSize()

Standard_Integer OSD_Disk::DiskSize

(

)

Returns total disk capacity in 512 bytes blocks.

Error()

Standard_Integer OSD_Disk::Error

(

)

const

Returns error number if 'Failed' is TRUE.

Failed()

Standard_Boolean OSD_Disk::Failed

(

)

const

Returns TRUE if an error occurs.

Name()

OSD_Path OSD_Disk::Name

(

)

const

Returns disk name of <me>.

Perror()

void OSD_Disk::Perror

(

)

Raises OSD_Error.

Reset()

void OSD_Disk::Reset

(

)

Resets error counter to zero.

SetDiskQuota()

void OSD_Disk::SetDiskQuota

(

const Standard_Integer

QuotaSize

)

Sets user's disk quota (in Bytes). Warning: Needs system administrator privilege.

SetName()

void OSD_Disk::SetName

(

const OSD_Path &

Name

)

Instantiates <me> with <Name>.

SetQuotaOff()

void OSD_Disk::SetQuotaOff

(

)

Deactivates user's disk quota Warning: Needs system administrator privilege.

SetQuotaOn()

void OSD_Disk::SetQuotaOn

(

)

Activates user's disk quota Warning: Needs system administrator privilege.

---

The documentation for this class was generated from the following file:

• OSD_Disk.hxx