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.
	OSD_Disk (const OSD_Path &Name)
	Initializes the object Disk with the disk name associated to the OSD_Path.
	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.
OSD_Path	Name () const
	Returns disk name of <me>.
void	SetName (const OSD_Path &Name)
	Instantiates <me> with <Name>.
Standard_Integer	DiskSize ()
	Returns total disk capacity in 512 bytes blocks.
Standard_Integer	DiskFree ()
	Returns free available 512 bytes blocks on disk.
Standard_Boolean	Failed () const
	Returns TRUE if an error occurs.
void	Reset ()
	Resets error counter to zero.
void	Perror ()
	Raises OSD_Error.
Standard_Integer	Error () const
	Returns error number if 'Failed' is TRUE.

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.

DiskSize()

Standard_Integer OSD_Disk::DiskSize

(

)

Returns total disk capacity in 512 bytes blocks.

Error()

Standard_Integer OSD_Disk::Error ( ) const

inline

Returns error number if 'Failed' is TRUE.

Failed()

Standard_Boolean OSD_Disk::Failed ( ) const

inline

Returns TRUE if an error occurs.

Name()

OSD_Path OSD_Disk::Name

(

)

const

Returns disk name of <me>.

Perror()

void OSD_Disk::Perror ( )

inline

Raises OSD_Error.

Reset()

void OSD_Disk::Reset ( )

inline

Resets error counter to zero.

SetName()

void OSD_Disk::SetName

(

const OSD_Path &

Name

)

Instantiates <me> with <Name>.

---

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

• OSD_Disk.hxx