itpp::binfile_details::Fstream_Binfile_Facade Class Reference

Fstream Interface Facade for Binary Streams.This class implements std::fstream facade to make ITPP binary file streams exportable from dll. This facade implements basic functionality only. It does not provide an access to the following stream facilities (all of them are useless for binary streams) More...

#include <itpp/base/binfile.h>

Inheritance diagram for itpp::binfile_details::Fstream_Binfile_Facade:

Public Member Functions
	Fstream_Binfile_Facade ()
	Default Constructor.
	Fstream_Binfile_Facade (const char *filename, std::ios_base::openmode mode=std::ios_base::in|std::ios_base::out|std::ios_base::binary)
	Constructor from filename and stream mode.
bool	is_open ()
	Open state.
void	open (const char *filename, std::ios_base::openmode mode=std::ios_base::in|std::ios_base::out|std::ios_base::binary)
	Method to open corresponding file.
void	close ()
	Method to close corresponding file.
Fstream_Binfile_Facade &	write (const char *c, std::streamsize n)
	Output multiple characters.
Fstream_Binfile_Facade &	put (const char c)
	Output single char.
std::streampos	tellp ()
	Get position.
Fstream_Binfile_Facade &	seekp (std::streampos pos)
	Set position.
Fstream_Binfile_Facade &	seekp (std::streamoff pos, std::ios_base::seekdir way)
	Set relative position.
Fstream_Binfile_Facade &	flush ()
	Flushes stream buffer.
std::streamsize	gcount () const
	Last extracted chars count.
int	get ()
	Get single char.
Fstream_Binfile_Facade &	get (char &c)
	Get single char.
Fstream_Binfile_Facade &	get (char *s, std::streamsize n)
	Get multiple chars to c-string and add trailing 0.
Fstream_Binfile_Facade &	get (char *s, std::streamsize n, char delim)
	Get multiple chars to c-string without trailing 0.
Fstream_Binfile_Facade &	getline (char *s, std::streamsize n)
	Get multiple chars to c-string without trailing 0.
Fstream_Binfile_Facade &	getline (char *s, std::streamsize n, char delim)
Fstream_Binfile_Facade &	ignore (std::streamsize n=1, int delim=EOF)
	Extract and ignore chars.
int	peek ()
	Peak single char from the top of the buffer.
Fstream_Binfile_Facade &	read (char *s, std::streamsize n)
	Read n chars from stream.
std::streamsize	readsome (char *s, std::streamsize n)
	Read up to n available chars from stream.
Fstream_Binfile_Facade &	putback (char c)
	This method attempts to put back single char.
Fstream_Binfile_Facade &	unget ()
	Unget last extracted char.
std::streampos	tellg ()
	Get position.
Fstream_Binfile_Facade &	seekg (std::streampos pos)
	Set position.
Fstream_Binfile_Facade &	seekg (std::streamoff pos, std::ios_base::seekdir way)
	Set relative position.
bool	good () const
	This method returns true is stream state is good.
bool	eof () const
	This method returns true if eof is reached.
bool	fail () const
	This method returns true if either failbit or badbit is set.
bool	bad () const
	This method returns true if badbit is set.
bool	operator! () const
	Unary not operator to check the stream state.
	operator bool () const
	Conversion to bool to validate stream state.
std::ios_base::iostate	rdstate () const
	Method to read stream state flags.
void	setstate (std::ios_base::iostate state)
	Method to set the stream state (combines already set flags with flags provide by user)
void	clear (std::ios_base::iostate state=std::ios_base::goodbit)
	Method to set stream state (overwrites stream state flags)
std::ios_base::iostate	exceptions () const
	Method to get the exceptions mask.
void	exceptions (std::ios_base::iostate except)
	Method to set the exceptions mask.
virtual	~Fstream_Binfile_Facade ()
	Destructor.

Protected Member Functions
std::fstream *	stream ()
	Access to internal stream for derived classes.

Detailed Description

Fstream Interface Facade for Binary Streams.

This class implements std::fstream facade to make ITPP binary file streams exportable from dll. This facade implements basic functionality only. It does not provide an access to the following stream facilities (all of them are useless for binary streams)

1. locale(imbue) It does not make sence to change locale settings for binary streams. Changes in formatting or char conversion can result in compatibility problems with resulting binary files
2. stream buffer (rdbuf). DLL and application can use different versions of runtime , so it would be dangerous to use buffer created in DLL in application context
3. stream extraction operators. It is assumed that stream extraction is defined in binary stream classes derived from this class
4. stream insertion operators. It is assumed that stream insertion is defined in binary stream classes derived from this class
5. formatting interface (copyfmt, fill, narrow, widen). This is not relevant to binary streams
6. ios_base-related stuff. These things are excluded since they provide unnecessarily formatting facilities.

Definition at line 354 of file binfile.h.

---

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

• itpp/base/binfile.h
• itpp/base/binfile.cpp