ldas-tools-frameAPI  2.6.6
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>

Inherits LDASTools::AL::Singleton< DeviceIOConfiguration >.

Public Member Functions

 DeviceIOConfiguration ()
 Constructor.
 
 ~DeviceIOConfiguration ()
 Destructor.
 

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 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: