Solid::StorageDrive Class

class Solid::StorageDrive

This device interface is available on storage devices. More...

Header: #include <Solid/StorageDrive>
CMake: find_package(KF6 REQUIRED COMPONENTS Solid)
target_link_libraries(mytarget PRIVATE KF6::Solid)
Inherits: Solid::DeviceInterface
Inherited By:

Solid::OpticalDrive

Public Types

enum Bus { Ide, Usb, Ieee1394, Scsi, Sata, Platform }
enum DriveType { HardDisk, CdromDrive, Floppy, Tape, CompactFlash, …, Xd }

Properties

Public Functions

Solid::StorageDrive::Bus bus() const
Solid::StorageDrive::DriveType driveType() const
bool isHotpluggable() const
bool isInUse() const
bool isRemovable() const
qulonglong size() const
(since 6.0) QDateTime timeDetected() const
(since 6.0) QDateTime timeMediaDetected() const

Static Public Members

Solid::DeviceInterface::Type deviceInterfaceType()

Detailed Description

A storage is anything that can contain a set of volumes (card reader, hard disk, cdrom drive...). It's a particular kind of block device.

Member Type Documentation

enum StorageDrive::Bus

This enum type defines the type of bus a storage device is attached to.

ConstantValueDescription
Solid::StorageDrive::Ide0An Integrated Drive Electronics (IDE) bus, also known as ATA
Solid::StorageDrive::Usb1An Universal Serial Bus (USB)
Solid::StorageDrive::Ieee13942An Ieee1394 bus, also known as Firewire
Solid::StorageDrive::Scsi3A Small Computer System Interface bus
Solid::StorageDrive::Sata4A Serial Advanced Technology Attachment (SATA) bus
Solid::StorageDrive::Platform5A legacy bus that is part of the underlying platform

enum StorageDrive::DriveType

This enum type defines the type of drive a storage device can be.

ConstantValueDescription
Solid::StorageDrive::HardDisk0A hard disk
Solid::StorageDrive::CdromDrive1An optical drive
Solid::StorageDrive::Floppy2A floppy disk drive
Solid::StorageDrive::Tape3A tape drive
Solid::StorageDrive::CompactFlash4A Compact Flash card reader
Solid::StorageDrive::MemoryStick5A Memory Stick card reader
Solid::StorageDrive::SmartMedia6A Smart Media card reader
Solid::StorageDrive::SdMmc7A SecureDigital/MultiMediaCard card reader
Solid::StorageDrive::Xd8A xD card reader

Property Documentation

[read-only] bus : const Bus

Access functions:

Solid::StorageDrive::Bus bus() const

[read-only] driveType : const DriveType

Access functions:

Solid::StorageDrive::DriveType driveType() const

[read-only] hotpluggable : const bool

Access functions:

bool isHotpluggable() const

[read-only] inUse : const bool

Access functions:

bool isInUse() const

[read-only] removable : const bool

Access functions:

bool isRemovable() const

[read-only] size : const qulonglong

Access functions:

qulonglong size() const

[read-only] timeDetected : const QDateTime

Access functions:

QDateTime timeDetected() const

[read-only] timeMediaDetected : const QDateTime

Access functions:

QDateTime timeDetected() const

Member Function Documentation

Solid::StorageDrive::Bus StorageDrive::bus() const

Retrieves the type of physical interface this storage device is connected to.

Returns the bus type

Note: Getter function for property bus.

See also Solid::StorageDrive::Bus.

[static] Solid::DeviceInterface::Type StorageDrive::deviceInterfaceType()

Get the Solid::DeviceInterface::Type of the StorageDrive device interface.

Returns the StorageDrive device interface type

See also Solid::DeviceInterface::Type.

Solid::StorageDrive::DriveType StorageDrive::driveType() const

Retrieves the type of this storage drive.

Returns the drive type

Note: Getter function for property driveType.

See also Solid::StorageDrive::DriveType.

bool StorageDrive::isHotpluggable() const

Indicates if this storage device can be plugged or unplugged while the computer is running.

Returns true if this storage supports hotplug, false otherwise

Note: Getter function for property hotpluggable.

bool StorageDrive::isInUse() const

Indicates if the storage device is currently in use i.e. if at least one child storage access is mounted

Returns true if at least one child storage access is mounted

Note: Getter function for property inUse.

bool StorageDrive::isRemovable() const

Indicates if the media contained by this drive can be removed.

For example memory card can be removed from the drive by the user, while partitions can't be removed from hard disks.

Returns true if media can be removed, false otherwise.

Note: Getter function for property removable.

qulonglong StorageDrive::size() const

Retrieves this drives size in bytes.

Returns the size of this drive

Note: Getter function for property size.

[since 6.0] QDateTime StorageDrive::timeDetected() const

Returns the time the drive was deteced. Typically this means the time a drive was plugged in, or the computer rebooted

An invalid datetime may be returned if the underlying information is not available

Note: Getter function for property timeDetected. Getter function for property timeMediaDetected.

This function was introduced in 6.0.

[since 6.0] QDateTime StorageDrive::timeMediaDetected() const

Returns the time media in the drive was deteced. Typically this means the time a card was inserted into a reader, or the computer rebooted

An invalid datetime may be returned if the underlying information is not available

This function was introduced in 6.0.