Dataflow Runtime API  3.0.3.0
Public Member Functions | List of all members
imt::base::os::winec7::StorageInfo Class Reference

Stores information of a storage. More...

#include <Imt.Base.OS.WinEC7/StorageInfo.h>

Public Member Functions

 StorageInfo (void)
 Constructor. More...
 
virtual ~StorageInfo (void)
 Destructor. More...
 
 StorageInfo (const StorageInfo &source)
 Copy constructor. More...
 
StorageInfooperator= (const StorageInfo &source)
 Assignment operator. More...
 
const std::wstring & getDeviceName (void) const
 Gets the name of the device. More...
 
void setDeviceName (const std::wstring &deviceName)
 Sets the name of the device. More...
 
const std::wstring & getStorageName (void) const
 Gets the name of the storage. More...
 
void setStorageName (const std::wstring &storageName)
 Sets the name of the storage. More...
 
uint32_t getDeviceType (void) const
 Gets the type of the device. More...
 
void setDeviceType (const uint32_t deviceType)
 Sets the type of the device. More...
 
uint32_t getDeviceFlags (void) const
 Gets the flags associated with the device. More...
 
void setDeviceFlags (const uint32_t deviceFlags)
 Sets the flags associated with the device. More...
 
bool getIsMounted (void) const
 Gets whether the file system is mounted. More...
 
void setIsMounted (const bool isMounted)
 Sets whether the file system is mounted. More...
 
const std::wstring & getFileSystemName (void) const
 Gets the file system name. More...
 
void setFileSystemName (const std::wstring &fileSystemName)
 Sets the file system name. More...
 
const std::wstring & getVolumeName (void) const
 Gets the path this storage is mounted to. More...
 
void setVolumeName (const std::wstring &volumeName)
 Sets the path this storage is mounted to. More...
 
uint64_t getDeviceSize (void) const
 Gets the total number of bytes this storage can contain. More...
 
void setDeviceSize (const uint64_t bytes)
 Sets the total number of bytes this storage can contain. More...
 

Detailed Description

Stores information of a storage.

Constructor & Destructor Documentation

◆ StorageInfo() [1/2]

imt::base::os::winec7::StorageInfo::StorageInfo ( void  )
explicit

Constructor.

◆ ~StorageInfo()

virtual imt::base::os::winec7::StorageInfo::~StorageInfo ( void  )
virtual

Destructor.

◆ StorageInfo() [2/2]

imt::base::os::winec7::StorageInfo::StorageInfo ( const StorageInfo source)

Copy constructor.

Parameters
sourceThe copy source

Member Function Documentation

◆ getDeviceFlags()

uint32_t imt::base::os::winec7::StorageInfo::getDeviceFlags ( void  ) const

Gets the flags associated with the device.

Returns
The flags associated with the device

◆ getDeviceName()

const std::wstring& imt::base::os::winec7::StorageInfo::getDeviceName ( void  ) const

Gets the name of the device.

Returns
The name of the device

◆ getDeviceSize()

uint64_t imt::base::os::winec7::StorageInfo::getDeviceSize ( void  ) const

Gets the total number of bytes this storage can contain.

Returns
The number of bytes

◆ getDeviceType()

uint32_t imt::base::os::winec7::StorageInfo::getDeviceType ( void  ) const

Gets the type of the device.

Returns
The type of the device

◆ getFileSystemName()

const std::wstring& imt::base::os::winec7::StorageInfo::getFileSystemName ( void  ) const

Gets the file system name.

Returns
The file system name

◆ getIsMounted()

bool imt::base::os::winec7::StorageInfo::getIsMounted ( void  ) const

Gets whether the file system is mounted.

Returns
Whether the file system is mounted

◆ getStorageName()

const std::wstring& imt::base::os::winec7::StorageInfo::getStorageName ( void  ) const

Gets the name of the storage.

Returns
The name of the storage

◆ getVolumeName()

const std::wstring& imt::base::os::winec7::StorageInfo::getVolumeName ( void  ) const

Gets the path this storage is mounted to.

Valid only if the file system is valid

Returns
The path this storage is mounted to. Valid only if the file system is valid

◆ operator=()

StorageInfo& imt::base::os::winec7::StorageInfo::operator= ( const StorageInfo source)

Assignment operator.

Parameters
sourceThe assignment source

◆ setDeviceFlags()

void imt::base::os::winec7::StorageInfo::setDeviceFlags ( const uint32_t  deviceFlags)

Sets the flags associated with the device.

Parameters
deviceFlagsThe flags associated with the device

◆ setDeviceName()

void imt::base::os::winec7::StorageInfo::setDeviceName ( const std::wstring &  deviceName)

Sets the name of the device.

Parameters
deviceNameThe name of the device

◆ setDeviceSize()

void imt::base::os::winec7::StorageInfo::setDeviceSize ( const uint64_t  bytes)

Sets the total number of bytes this storage can contain.

Parameters
bytesThe number of bytes

◆ setDeviceType()

void imt::base::os::winec7::StorageInfo::setDeviceType ( const uint32_t  deviceType)

Sets the type of the device.

Parameters
deviceTypeThe type of the device

◆ setFileSystemName()

void imt::base::os::winec7::StorageInfo::setFileSystemName ( const std::wstring &  fileSystemName)

Sets the file system name.

Parameters
fileSystemNameThe file system name

◆ setIsMounted()

void imt::base::os::winec7::StorageInfo::setIsMounted ( const bool  isMounted)

Sets whether the file system is mounted.

Parameters
isMountedIndicates whether the file system is mounted

◆ setStorageName()

void imt::base::os::winec7::StorageInfo::setStorageName ( const std::wstring &  storageName)

Sets the name of the storage.

Parameters
storageNameThe name of the storage

◆ setVolumeName()

void imt::base::os::winec7::StorageInfo::setVolumeName ( const std::wstring &  volumeName)

Sets the path this storage is mounted to.

Valid only if the file system is valid

Parameters
volumeNameThe path this storage is mounted to. Valid only if the file system is valid

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