ldas-tools-frameAPI  2.6.4
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
FileReader Class Reference

#include <filereader.hh>

Inheritance diagram for FileReader:
Inheritance graph
[legend]
Collaboration diagram for FileReader:
Collaboration graph
[legend]

Public Member Functions

 FileReader (const char *filename, unsigned int size=FrameAPI::StreamBufferSize, char *buffer=(char *) NULL, bool EnableMemoryMappedIO=FrameAPI::EnableMemoryMappedIO, bool VerifyFilename=false)
 
 FileReader (const char *filename, unsigned int size=FrameAPI::StreamBufferSize, char *buffer=(char *) NULL, bool EnableMemoryMappedIO=FrameAPI::EnableMemoryMappedIO, bool VerifyFilename=false)
 
 FileReader (const char *filename, unsigned int size=FrameAPI::StreamBufferSize, char *buffer=(char *) NULL, bool EnableMemoryMappedIO=FrameAPI::EnableMemoryMappedIO, bool VerifyFilename=false)
 
const std::string & GetFilename () const
 ret: const std::string& - Name of the file More...
 
const std::string & GetFilename () const
 
const std::string & GetFilename () const
 

Protected Types

typedef LDASTools::AL::filebuf filebuf
 
typedef LDASTools::AL::filebuf filebuf
 
typedef LDASTools::AL::filebuf filebuf
 

Protected Member Functions

void finish ()
 
void finish ()
 
void finish ()
 

Protected Attributes

FrameCPP::Common::FrameBuffer< filebuf > * m_frame_buf
 

Member Typedef Documentation

◆ filebuf [1/3]

typedef LDASTools::AL::filebuf FrameFile::filebuf
protectedinherited

◆ filebuf [2/3]

typedef LDASTools::AL::filebuf FrameFile::filebuf
protectedinherited

◆ filebuf [3/3]

typedef LDASTools::AL::filebuf FrameFile::filebuf
protectedinherited

Constructor & Destructor Documentation

◆ FileReader() [1/3]

FileReader::FileReader ( const char *  filename,
unsigned int  size = FrameAPI::StreamBufferSize,
char *  buffer = (char*)NULL,
bool  EnableMemoryMappedIO = FrameAPI::EnableMemoryMappedIO,
bool  VerifyFilename = false 
)

exc: SwigException exc: bad_alloc - Memory allocation failed.

Parameters
[in]filenameThe name of the frame file.
[in]sizeSize of the buffer to use. If the value is zero, then the default size will be used and the buffer parameter will be ignored
[in]bufferOptional buffer for i/o. If the value is (char*)NULL, then the class will allocate and manage a buffer based on size.
[in]EnableMemoryMappedIOTrue if memory mapped io is to be used
[in]VerifyFilenameTrue if the filename is to be verified against the internal data.

◆ FileReader() [2/3]

FileReader::FileReader ( const char *  filename,
unsigned int  size = FrameAPI::StreamBufferSize,
char *  buffer = (char *) NULL,
bool  EnableMemoryMappedIO = FrameAPI::EnableMemoryMappedIO,
bool  VerifyFilename = false 
)

exc: SwigException exc: bad_alloc - Memory allocation failed.

◆ FileReader() [3/3]

FileReader::FileReader ( const char *  filename,
unsigned int  size = FrameAPI::StreamBufferSize,
char *  buffer = (char *) NULL,
bool  EnableMemoryMappedIO = FrameAPI::EnableMemoryMappedIO,
bool  VerifyFilename = false 
)

exc: SwigException exc: bad_alloc - Memory allocation failed.

Member Function Documentation

◆ finish() [1/3]

void FrameFile::finish ( )
inlineprotectedinherited
Todo:
Need to understand why this causes instability in the frameAPI. Use libumem to quickly raise the issue.

◆ finish() [2/3]

void FrameFile::finish ( )
protectedinherited

◆ finish() [3/3]

void FrameFile::finish ( )
protectedinherited

◆ GetFilename() [1/3]

const std::string& FrameFile::GetFilename ( ) const
inherited

◆ GetFilename() [2/3]

const std::string & FrameFile::GetFilename ( ) const
inlineinherited

ret: const std::string& - Name of the file

◆ GetFilename() [3/3]

const std::string& FrameFile::GetFilename ( ) const
inherited

Member Data Documentation

◆ m_frame_buf

FrameCPP::Common::FrameBuffer< filebuf > * FrameFile::m_frame_buf
protectedinherited

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