andrius
/
kpmcore
1
0
Fork 0
Code Pull Requests Releases Activity

Docs: document Device (a description) and CoreBackendDevice (an operational class)

This commit is contained in:
Adriaan de Groot 2017-10-03 05:23:10 -04:00
parent 98caf84424
commit c4ae5d680c
3 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/backend/corebackend.h
View File

@ -93,6 +93,8 @@ public:
* not, including CD ROM devices, are returned. * not, including CD ROM devices, are returned.
* @return a QList of pointers to Device instances. The caller is responsible * @return a QList of pointers to Device instances. The caller is responsible
* for deleting these objects. * for deleting these objects.
* @note A Device object is a description of the device, not
* an object to operate on. See openDevice().
*/ */
virtual QList<Device*> scanDevices(bool excludeReadOnly = false) = 0; virtual QList<Device*> scanDevices(bool excludeReadOnly = false) = 0;

6
src/backend/corebackenddevice.h
View File

@ -30,7 +30,11 @@ class PartitionTable;
class Report; class Report;
/** /**
* Interface class representing a device in the backend plugin. * Interface class for devices in the backend plugin.
* For a device description, see Device. This
* CoreBackendDevice can be used for (read- and) write
* operations on the raw device.
*
* @author Volker Lanz <vl@fidra.de> * @author Volker Lanz <vl@fidra.de>
*/ */
class LIBKPMCORE_EXPORT CoreBackendDevice class LIBKPMCORE_EXPORT CoreBackendDevice

11
src/core/device.h
View File

@ -29,9 +29,11 @@ class CreatePartitionTableOperation;
class CoreBackend; class CoreBackend;
class SmartStatus; class SmartStatus;
/** A abstract device interface. /** A device description.
Represents a device like /dev/sda. Represents a device like /dev/sda. Contains information about
the device (name, status, size ..) but does not operate on
the device itself. @see CoreBackendDevice
Devices are the outermost entity; they contain a PartitionTable that itself contains Partitions. Devices are the outermost entity; they contain a PartitionTable that itself contains Partitions.
@ -104,6 +106,11 @@ public:
return *m_SmartStatus; return *m_SmartStatus;
} }
/**
* Change the description of the partition table for different one.
* The device itself is not changed; use CreatePartitionTableOperation
* for that. The Device instance becomes the owner of @p ptable .
*/
virtual void setPartitionTable(PartitionTable* ptable) { virtual void setPartitionTable(PartitionTable* ptable) {
m_PartitionTable = ptable; m_PartitionTable = ptable;
} }