FileWriter Class Reference

#include <filereader.hh>

Inheritance diagram for FileWriter:

Collaboration diagram for FileWriter:

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

Private Member Functions
int	rename_file ()
void	update (object_type FrameObject)
int	rename_file ()
void	update (object_type FrameObject)
int	rename_file ()
void	update (object_type FrameObject)

Private Attributes
file_start_time_type	file_start_time
file_dt_type	file_dt
file_frame_count_type	file_frame_count
std::string	mTmpFilename
FrameCPP::Common::MD5Sum	m_md5

Member Typedef Documentation

chkSum_type [1/3]

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

chkSum_type [2/3]

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

chkSum_type [3/3]

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

file_dt_type [1/3]

typedef INT_4U FileWriter::file_dt_type

file_dt_type [2/3]

typedef INT_4U FileWriter::file_dt_type

file_dt_type [3/3]

typedef INT_4U FileWriter::file_dt_type

file_frame_count_type [1/3]

typedef INT_4U FileWriter::file_frame_count_type

file_frame_count_type [2/3]

typedef INT_4U FileWriter::file_frame_count_type

file_frame_count_type [3/3]

typedef INT_4U FileWriter::file_frame_count_type

file_start_time_type [1/3]

typedef INT_4U FileWriter::file_start_time_type

file_start_time_type [2/3]

typedef INT_4U FileWriter::file_start_time_type

file_start_time_type [3/3]

typedef INT_4U FileWriter::file_start_time_type

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

FileWriter() [1/6]

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/6]

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() [1/3]

FileWriter::~FileWriter

(

)

FileWriter() [3/6]

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

exc: SwigException

FileWriter() [4/6]

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

~FileWriter() [2/3]

FileWriter::~FileWriter

(

)

FileWriter() [5/6]

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

exc: SwigException

FileWriter() [6/6]

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

~FileWriter() [3/3]

FileWriter::~FileWriter

(

)

Member Function Documentation

Dt() [1/3]

FileWriter::file_dt_type FileWriter::Dt ( ) const

inline

Dt() [2/3]

file_dt_type FileWriter::Dt

(

)

const

Dt() [3/3]

file_dt_type FileWriter::Dt

(

)

const

finish() [1/3]

void FrameFile::finish ( )

protectedinherited

finish() [2/3]

void FrameFile::finish ( )

protectedinherited

finish() [3/3]

void FrameFile::finish ( )

inlineprotectedinherited

Todo:

Need to understand why this causes instability in the frameAPI. Use libumem to quickly raise the issue.

FrameCount() [1/3]

FileWriter::file_frame_count_type FileWriter::FrameCount ( ) const

inline

FrameCount() [2/3]

file_frame_count_type FileWriter::FrameCount

(

)

const

FrameCount() [3/3]

file_frame_count_type FileWriter::FrameCount

(

)

const

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

Rename() [1/3]

void FileWriter::Rename

(

)

Rename() [2/3]

void FileWriter::Rename

(

)

Rename() [3/3]

void FileWriter::Rename

(

)

rename_file() [1/3]

int FileWriter::rename_file ( )

private

rename_file() [2/3]

int FileWriter::rename_file ( )

private

rename_file() [3/3]

int FileWriter::rename_file ( )

private

ResetMD5Sum() [1/3]

void FileWriter::ResetMD5Sum

(

bool

CalculateMD5Sum

)

ResetMD5Sum() [2/3]

void FileWriter::ResetMD5Sum ( bool  CalculateMD5Sum )

inline

ResetMD5Sum() [3/3]

void FileWriter::ResetMD5Sum

(

bool

CalculateMD5Sum

)

StartTime() [1/3]

FileWriter::file_start_time_type FileWriter::StartTime ( ) const

inline

StartTime() [2/3]

file_start_time_type FileWriter::StartTime

(

)

const

StartTime() [3/3]

file_start_time_type FileWriter::StartTime

(

)

const

update() [1/3]

void FileWriter::update ( object_type  FrameObject )

inlineprivate

update() [2/3]

void FileWriter::update ( object_type  FrameObject )

private

update() [3/3]

void FileWriter::update ( object_type  FrameObject )

private

WriteFrame() [1/6]

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

Write Frame data to the stream.

WriteFrame() [2/6]

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

Write Frame data to the stream.

WriteFrame() [3/6]

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

Write Frame data to the stream.

WriteFrame() [4/6]

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.

WriteFrame() [5/6]

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.

WriteFrame() [6/6]

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

file_dt

file_dt_type FileWriter::file_dt

private

file_frame_count

file_frame_count_type FileWriter::file_frame_count

private

file_start_time

file_start_time_type FileWriter::file_start_time

private

m_frame_buf

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

protectedinherited

m_md5

FrameCPP::Common::MD5Sum FileWriter::m_md5

private

mTmpFilename

std::string FileWriter::mTmpFilename

mutableprivate

---

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

• /build/ldas-tools-frameapi-2.6.6/debian/tmp/usr/include/frameAPI/filereader.hh
• /build/ldas-tools-frameapi-2.6.6/src/filereader.cc