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

#include <filereader.hh>

Inheritance diagram for FileWriter:
FrameFile

Public Types

typedef INT_4U file_start_time_type
 
typedef INT_4U file_dt_type
 
typedef INT_4U file_frame_count_type
 
typedef FrameCPP::Common::OFrameStream::chkSum_type chkSum_type
 

Public Member Functions

 FileWriter (const char *filename, const char *tmp_filename=(const char *) NULL)
 exc: SwigException More...
 
 FileWriter (const char *filename, unsigned int size, char *buffer=(char *) NULL, bool EnableMemoryMappedIO=FrameAPI::EnableMemoryMappedIO, const char *tmp_filename=(const char *) NULL)
 exc: SwigException More...
 
 ~FileWriter ()
 
file_dt_type Dt () const
 
file_frame_count_type FrameCount () const
 
void Rename ()
 
void ResetMD5Sum (bool CalculateMD5Sum)
 
file_start_time_type StartTime () const
 
void WriteFrame (object_type FrameObject, chkSum_type FrameChecksumType=FrameCPP::Common::CheckSum::NONE)
 Write Frame data to the stream. More...
 
void WriteFrame (object_type FrameObject, INT_2U CompressionScheme, INT_2U CompressionLevel, chkSum_type FrameChecksumType=FrameCPP::Common::CheckSum::NONE)
 Write Frame data to the stream. More...
 
const std::string & GetFilename () const
 ret: const std::string& - Name of the file More...
 

Protected Types

typedef LDASTools::AL::filebuf filebuf
 

Protected Member Functions

void finish ()
 

Protected Attributes

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

Member Typedef Documentation

◆ chkSum_type

typedef FrameCPP::Common::OFrameStream::chkSum_type FileWriter::chkSum_type

◆ file_dt_type

typedef INT_4U FileWriter::file_dt_type

◆ file_frame_count_type

◆ file_start_time_type

◆ filebuf

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

Constructor & Destructor Documentation

◆ FileWriter() [1/2]

FileWriter::FileWriter ( const char *  filename,
const char *  tmp_filename = (const char*) NULL 
)

exc: SwigException

param: unsigned int size - size of the buffer to use. If the value

param: const char* filename - The name of the frame file. param: char* buffer - optional buffer for i/o. If the value isparam: const char* tmp_filename - The name of the temporary file. NOTE: exc: SwigException - this is one of:

◆ FileWriter() [2/2]

FileWriter::FileWriter ( const char *  filename,
unsigned int  size,
char *  buffer = (char*)NULL,
bool  EnableMemoryMappedIO = FrameAPI::EnableMemoryMappedIO,
const char *  tmp_filename = (const char*) NULL 
)

exc: SwigException

param: unsigned int size - size of the buffer to use. If the value

param: const char* filename - The name of the frame file. param: char* buffer - optional buffer for i/o. If the value isparam: const char* tmp_filename - The name of the temporary file. NOTE: exc: SwigException - this is one of:

◆ ~FileWriter()

FileWriter::~FileWriter ( )

Member Function Documentation

◆ Dt()

FileWriter::file_dt_type FileWriter::Dt ( ) const
inline

◆ finish()

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

◆ FrameCount()

FileWriter::file_frame_count_type FileWriter::FrameCount ( ) const
inline

◆ GetFilename()

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

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

◆ Rename()

void FileWriter::Rename ( )

◆ ResetMD5Sum()

void FileWriter::ResetMD5Sum ( bool  CalculateMD5Sum)
inline

◆ StartTime()

FileWriter::file_start_time_type FileWriter::StartTime ( ) const
inline

◆ WriteFrame() [1/2]

void FileWriter::WriteFrame ( object_type  FrameObject,
chkSum_type  FrameChecksumType = FrameCPP::Common::CheckSum::NONE 
)

Write Frame data to the stream.

◆ WriteFrame() [2/2]

void FileWriter::WriteFrame ( object_type  FrameObject,
INT_2U  CompressionScheme,
INT_2U  CompressionLevel,
chkSum_type  FrameChecksumType = FrameCPP::Common::CheckSum::NONE 
)

Write Frame data to the stream.

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: