storage::LvmPv Class Reference

Inheritance diagram for storage::LvmPv:

Collaboration diagram for storage::LvmPv:

Public Member Functions
bool	has_blk_device () const
	Check whether the physical volume has a block device.
BlkDevice *	get_blk_device ()
	Return the block device this physical volume is using.
const BlkDevice *	get_blk_device () const
	Return the block device this physical volume is using.
unsigned long long	get_usable_size () const
	Get the size of the PV usable for extents in bytes.
bool	has_lvm_vg () const
	Check whether the physical volume is part of a volume group.
LvmVg *	get_lvm_vg ()
	Return the volume group the physical volume is used in.
const LvmVg *	get_lvm_vg () const
	Return the volume group the physical volume is used in.
Impl &	get_impl ()
const Impl &	get_impl () const
virtual LvmPv *	clone () const override
virtual std::unique_ptr< Device >	clone_v2 () const override
	LvmPv (Impl *impl)
ST_NO_SWIG	LvmPv (std::unique_ptr< Device::Impl > &&impl)
Public Member Functions inherited from storage::Device
sid_t	get_sid () const
	Return the storage id (sid) of the device.
bool	operator== (const Device &rhs) const
bool	operator!= (const Device &rhs) const
Device *	copy_to_devicegraph (Devicegraph *devicegraph) const
	Copies the device to the devicegraph.
bool	exists_in_devicegraph (const Devicegraph *devicegraph) const
	Checks if the device exists in the devicegraph.
bool	exists_in_probed () const
	Checks if the device exists in the probed devicegraph.
bool	exists_in_staging () const
	Checks if the device exists in the staging devicegraph.
bool	exists_in_system () const
	Checks if the device exists in the system devicegraph.
std::string	get_displayname () const
ResizeInfo	detect_resize_info () const
	Detect the resize info of the device.
bool	has_children () const
size_t	num_children () const
bool	has_parents () const
size_t	num_parents () const
std::vector< Device * >	get_children ()
std::vector< const Device * >	get_children () const
std::vector< Device * >	get_children (View view)
	Get all children of the device.
std::vector< const Device * >	get_children (View view) const
	Get all children of the device.
std::vector< Device * >	get_parents ()
std::vector< const Device * >	get_parents () const
std::vector< Device * >	get_parents (View view)
	Get all parents of the device.
std::vector< const Device * >	get_parents (View view) const
	Get all parents of the device.
std::vector< Device * >	get_siblings (bool itself)
std::vector< const Device * >	get_siblings (bool itself) const
std::vector< Device * >	get_descendants (bool itself)
std::vector< const Device * >	get_descendants (bool itself) const
std::vector< Device * >	get_descendants (bool itself, View view)
std::vector< const Device * >	get_descendants (bool itself, View view) const
std::vector< Device * >	get_ancestors (bool itself)
std::vector< const Device * >	get_ancestors (bool itself) const
std::vector< Device * >	get_leaves (bool itself)
std::vector< const Device * >	get_leaves (bool itself) const
std::vector< Device * >	get_roots (bool itself)
std::vector< const Device * >	get_roots (bool itself) const
std::vector< Holder * >	get_in_holders ()
std::vector< const Holder * >	get_in_holders () const
std::vector< Holder * >	get_out_holders ()
std::vector< const Holder * >	get_out_holders () const
void	remove_descendants () ST_DEPRECATED
void	remove_descendants (View view)
	Remove all descendants of the device.
const std::map< std::string, std::string > &	get_userdata () const
	Return the userdata of the device.
void	set_userdata (const std::map< std::string, std::string > &userdata)
	Set the userdata of the device.
std::string	get_name_sort_key () const
	Get a sort-key based on the device name.
Devicegraph *	get_devicegraph ()
	Return the devicegraph the device belongs to.
const Devicegraph *	get_devicegraph () const
	Return the devicegraph the device belongs to.
Impl &	get_impl ()
const Impl &	get_impl () const
void	save (xmlNode *node) const ST_DEPRECATED

Static Public Member Functions
static LvmPv *	create (Devicegraph *devicegraph)
	Create a device of type LvmPv.
static LvmPv *	load (Devicegraph *devicegraph, const xmlNode *node)
static std::vector< LvmPv * >	get_all (Devicegraph *devicegraph)
	Get all LvmPvs.
static std::vector< const LvmPv * >	get_all (const Devicegraph *devicegraph)
	Get all LvmPvs.
Static Public Member Functions inherited from storage::Device
static std::vector< Device * >	get_all (Devicegraph *devicegraph)
	Get all Devices.
static std::vector< const Device * >	get_all (const Devicegraph *devicegraph)
	Get all Devices.
static bool	compare_by_sid (const Device *lhs, const Device *rhs)
	Compare (less than) two Devices by sid.
static bool	compare_by_name (const Device *lhs, const Device *rhs)
	Compare (less than) two Devices by name.

Additional Inherited Members
Protected Member Functions inherited from storage::Device
	Device (Impl *impl) ST_DEPRECATED
ST_NO_SWIG	Device (std::unique_ptr< Impl > &&impl)
void	create (Devicegraph *devicegraph) ST_DEPRECATED
	Create a device in the devicegraph.
void	load (Devicegraph *devicegraph) ST_DEPRECATED

Member Function Documentation

clone()

virtual LvmPv * storage::LvmPv::clone ( ) const

overridevirtual

Implements storage::Device.

clone_v2()

virtual std::unique_ptr< Device > storage::LvmPv::clone_v2 ( ) const

overridevirtual

Implements storage::Device.

create()

LvmPv * storage::LvmPv::create ( Devicegraph * devicegraph )

static

Create a device of type LvmPv.

Usually this function is not called directly. Instead LvmVg::add_lvm_pv() is called.

See also

Device::create(Devicegraph*)

get_all()

std::vector< const LvmPv * > storage::LvmPv::get_all ( const Devicegraph * devicegraph )

static

Get all LvmPvs.

get_blk_device() [1/2]

BlkDevice * storage::LvmPv::get_blk_device

(

)

Return the block device this physical volume is using.

Exceptions

Exception

get_blk_device() [2/2]

const BlkDevice * storage::LvmPv::get_blk_device

(

)

const

Return the block device this physical volume is using.

Exceptions

Exception

get_lvm_vg() [1/2]

LvmVg * storage::LvmPv::get_lvm_vg

(

)

Return the volume group the physical volume is used in.

Exceptions

Exception

get_lvm_vg() [2/2]

const LvmVg * storage::LvmPv::get_lvm_vg

(

)

const

Return the volume group the physical volume is used in.

Exceptions

Exception

get_usable_size()

unsigned long long storage::LvmPv::get_usable_size

(

)

const

Get the size of the PV usable for extents in bytes.

Can be 0 (if pe_start >= size of blk device).

Exceptions

Exception

has_blk_device()

bool storage::LvmPv::has_blk_device

(

)

const

Check whether the physical volume has a block device.

Normally this is the case, but LVM may report block devices as missing during probing.

---

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

• /home/abuild/rpmbuild/BUILD/libstorage-ng-4.5.312-build/libstorage-ng-4.5.312/storage/Devices/LvmPv.h