OMV\System\Storage\StorageDeviceHDD Class Reference

Inheritance diagram for OMV\System\Storage\StorageDeviceHDD:

Public Member Functions
	getPowerModeState ()
	getSmartDeviceType ()
Public Member Functions inherited from OMV\System\Storage\SmartStorageDeviceAbstract
	getSmartDeviceType ()
	getSmartInformation ()
	executeSmartSelfTest ($test)
Public Member Functions inherited from OMV\System\Storage\StorageDevice
	getModel ()
	getVendor ()
	getSerialNumber ()
	getDescription ()
	isRotational ()
	isRemovable ()
	isRaid ()
	isUsb ()
	isAta ()
	isReadOnly ()
	IsMediaAvailable ()
	hasSmartSupport ()
	assertHasSmartSupport ()
	wipe ()
Public Member Functions inherited from OMV\System\BlockDevice
	__construct ($deviceFile)
	exists ()
	assertExists ()
	getDeviceFile ()
	getCanonicalDeviceFile ()
	getDeviceFileById ()
	hasDeviceFileById ()
	getDeviceFileByPath ()
	hasDeviceFileByPath ()
	getPredictableDeviceFile ()
	getPreferredDeviceFile ()
	getDeviceFileSymlinks ()
	getDeviceName ($canonical=FALSE)
	getSize ()
	getBlockSize ()
	getSectorSize ()
	getDeviceNumber ()
	getMajor ()
	getMinor ()
	getDescription ()
	hasUdevProperty ($id)
	assertUdevProperty ($id)
	getUdevProperty ($id)
	waitForDevice ($timeout)
Public Member Functions inherited from OMV\System\Storage\IStorageDevice
	exists ()
	getDeviceFile ()
	getCanonicalDeviceFile ()
	getDeviceFileById ()
	hasDeviceFileById ()
	getDeviceFileSymlinks ()
	getDeviceName ($canonical=FALSE)
	getSize ()
	getBlockSize ()
	getSectorSize ()
	isMediaAvailable ()

Additional Inherited Members
Static Public Member Functions inherited from OMV\System\Storage\StorageDevice
static	enumerate ($type=OMV_STORAGE_DEVICE_TYPE_ALL)
static	enumerateUnused ($type=OMV_STORAGE_DEVICE_TYPE_ALL)
static	enumerateUsed ($type=OMV_STORAGE_DEVICE_TYPE_ALL)
static	isUsed ($deviceFile, $type=OMV_STORAGE_DEVICE_TYPE_ALL)
static	getStorageDevice ($deviceFile)
static	assertStorageDeviceExists ($deviceFile)
Protected Member Functions inherited from OMV\System\Storage\SmartStorageDeviceAbstract
	setSmartDeviceType ($type)
Protected Member Functions inherited from OMV\System\BlockDevice
	getUdevData ($force=FALSE)
Protected Attributes inherited from OMV\System\Storage\StorageDevice
	$model = NULL
	$vendor = NULL
Protected Attributes inherited from OMV\System\BlockDevice
	$deviceFile = NULL
	$deviceFileById = NULL
	$size = FALSE
	$blockSize = FALSE
	$sectorSize = FALSE
	$udevData = NULL

Detailed Description

This class provides a simple interface to handle ATA/SATA and SCSI hard disk devices. Try to use sysfs only to get the required information, otherwise the disk will spin-up if it is in sleep mode.

Member Function Documentation

getPowerModeState()

OMV\System\Storage\StorageDeviceHDD::getPowerModeState

(

)

Get the current power mode status.

Returns

The current power mode status which can be

unknown

• active/idle
• standby
• sleeping

Exceptions

getSmartDeviceType()

OMV\System\Storage\StorageDeviceHDD::getSmartDeviceType

(

)

Identify the device type required by the smartctl command.

Returns

Returns the identified device type or an empty string.

Implements OMV\System\Storage\ISmartStorageDevice.

---

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

• storagedevicehdd.inc