hwdet::BeenDisk Class Reference

This class stores information about drive space available for BEEN to use. More...

#include <BeenDisk.h>

Inheritance diagram for hwdet::BeenDisk:

Public Member Functions
	BeenDisk (void)
	Default ctor.
	BeenDisk (const String &Path, unsigned long long user_total_size, unsigned long long user_free)
	Constructor.
String	GetPath (void) const
	Get path to the root of the BEEN installation.
void	SetPath (const String &value)
	Set path.
unsigned long long	GetDiskSize (void) const
	Get size of the disk BEEN is located on.
void	SetDiskSize (unsigned long long value)
	Set size of the drive.
unsigned long long	GetUserFree (void) const
	Get free space available on disk BEEN is located on.
void	SetUserFree (unsigned long long value)
	Set size of the free space.
Private Attributes
XMLValueElement< String > *	path
	Path to root folder.
XMLValueElement< unsigned long long > *	size
	Size of the drive.
XMLValueElement< unsigned long long > *	free_space
	Free space on the drive.

---

Detailed Description

This class stores information about drive space available for BEEN to use.

---

Constructor & Destructor Documentation

hwdet::BeenDisk::BeenDisk

(

void

)

Default ctor.

hwdet::BeenDisk::BeenDisk	(	const String &	Path,
		unsigned long long	user_total_size,
		unsigned long long	user_free
	)

Constructor.

Parameters:

	Path	Path to the directory with BEEN installation.
	user_total_size	Total disk space available to the current user.
	user_free	Free disk space available to the current user.

---

Member Function Documentation

unsigned long long hwdet::BeenDisk::GetDiskSize

(

void

)

const

Get size of the disk BEEN is located on.

Returns:

Size of the disk with BEEN as seen by the user associated with current thread. This may be less than total number of bytes available on the drive due to the per-user quotas.

String hwdet::BeenDisk::GetPath

(

void

)

const

Get path to the root of the BEEN installation.

Returns:

Path to the root directory of the BEEN installation.

unsigned long long hwdet::BeenDisk::GetUserFree

(

void

)

const

Get free space available on disk BEEN is located on.

Returns:

Free space available to the user associated with the current thread. This may be less than total number of free bytes available due to the per-user quotas.

void hwdet::BeenDisk::SetDiskSize

(

unsigned long long

value

)

Set size of the drive.

Parameters:

value

New size of the disk in bytes.

void hwdet::BeenDisk::SetPath

(

const String &

value

)

Set path.

Parameters:

value

New path to the BEEN_HOME.

void hwdet::BeenDisk::SetUserFree

(

unsigned long long

value

)

Set size of the free space.

Parameters:

value

New free space in bytes.

---

Field Documentation

XMLValueElement< unsigned long long >* hwdet::BeenDisk::free_space [private]

Free space on the drive.

XMLValueElement< String >* hwdet::BeenDisk::path [private]

Path to root folder.

XMLValueElement< unsigned long long >* hwdet::BeenDisk::size [private]

Size of the drive.

---

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

• BeenDisk.h
• BeenDisk.cpp

---