ldas-tools-frameAPI  2.5.1
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
FrameAPI::DeviceIOConfiguration Class Reference

Singleton to keep track of how to support io on a device. More...

#include <DeviceIOConfiguration.hh>

Inheritance diagram for FrameAPI::DeviceIOConfiguration:

Classes

struct  Characteristics
 
struct  Description
 

Public Types

typedef INT_8U dev_type
 
typedef FrameCPP::Common::FrameBufferInterface::buffer_size_type size_type
 
typedef bool use_mmap_io_type
 
typedef std::vector< Descriptiondescriptions_type
 

Public Member Functions

 DeviceIOConfiguration ()
 Constructor. More...
 
 ~DeviceIOConfiguration ()
 Destructor. More...
 

Static Public Member Functions

static void GetConfiguration (const char *Filename, size_type &BufferSize, bool &UseMemoryMappedIO)
 Fetch the options for the device associated with the file. More...
 
static void GetConfiguration (const char *Filename, size_type &BufferSize, bool &UseMemoryMappedIO, std::string &FSType)
 Fetch the options for the device associated with the file. More...
 
static std::string Reset (const descriptions_type &Descriptions)
 Resets the cache to be empty. More...
 

Detailed Description

Singleton to keep track of how to support io on a device.

Member Typedef Documentation

◆ descriptions_type

◆ dev_type

◆ size_type

typedef FrameCPP::Common::FrameBufferInterface::buffer_size_type FrameAPI::DeviceIOConfiguration::size_type

◆ use_mmap_io_type

Constructor & Destructor Documentation

◆ DeviceIOConfiguration()

DeviceIOConfiguration::DeviceIOConfiguration ( )

Constructor.

◆ ~DeviceIOConfiguration()

DeviceIOConfiguration::~DeviceIOConfiguration ( )

Destructor.

Member Function Documentation

◆ GetConfiguration() [1/2]

void FrameAPI::DeviceIOConfiguration::GetConfiguration ( const char *  Filename,
size_type BufferSize,
bool &  UseMemoryMappedIO 
)
inlinestatic

Fetch the options for the device associated with the file.

Parameters
[in]FilenameThe name of the file on the device being queried.
[out]BufferSizeThe optimal size of the buffer for the device.
[out]UseMemoryMappedIOTrue if the device performance is enhanced by using memory mapped I/O.

◆ GetConfiguration() [2/2]

void DeviceIOConfiguration::GetConfiguration ( const char *  Filename,
size_type BufferSize,
bool &  UseMemoryMappedIO,
std::string &  FSType 
)
static

Fetch the options for the device associated with the file.

Parameters
[in]FilenameThe name of the file on the device being queried.
[out]BufferSizeThe optimal size of the buffer for the device.
[out]UseMemoryMappedIOTrue if the device performance is enhanced by using memory mapped I/O.
[out]FSTypeThe description of the file type for the device being queried.

◆ Reset()

std::string DeviceIOConfiguration::Reset ( const descriptions_type Descriptions)
static

Resets the cache to be empty.

Parameters
[out]DescriptionsList of names or file system types that are to be reset.
Returns
List of warning messages generated while trying to reset.

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