chomik::generic_stream Class Reference

#include <chomik.h>

Inheritance diagram for chomik::generic_stream:

Public Member Functions
	generic_stream ()
void	set_max_size (int ms)
virtual	~generic_stream ()
virtual bool	get_allows_input () const
virtual bool	get_allows_output () const
virtual bool	get_should_be_opened () const
virtual bool	get_should_be_closed () const
virtual std::ostream &	get_output_stream ()
virtual std::istream &	get_input_stream ()
virtual std::string	get_result () const
virtual std::string	getline_result () const
virtual void	set_result (const std::string &r)
virtual int	read_integer ()
virtual bool	read_char (unsigned char &target)
virtual std::string	read_string ()
virtual void	getline ()
virtual bool	get_is_good ()

Protected Member Functions
void	read_string_of_x_characters (std::string &target, unsigned x)

Protected Attributes
int	max_size

Detailed Description

The base class of all streams used by a chomik program.

Constructor & Destructor Documentation

generic_stream()

chomik::generic_stream::generic_stream ( )

inline

~generic_stream()

virtual chomik::generic_stream::~generic_stream ( )

inlinevirtual

Member Function Documentation

get_allows_input()

virtual bool chomik::generic_stream::get_allows_input ( ) const

inlinevirtual

Reimplemented in chomik::generic_stream_file_input, chomik::generic_stream_random_enum_stream, chomik::generic_stream_random_number_stream, chomik::generic_stream_standard_input_stream, and chomik::generic_stream_stringstream.

get_allows_output()

virtual bool chomik::generic_stream::get_allows_output ( ) const

inlinevirtual

Reimplemented in chomik::generic_stream_file_output, chomik::generic_stream_standard_error_stream, chomik::generic_stream_standard_output_stream, and chomik::generic_stream_stringstream.

get_input_stream()

virtual std::istream & chomik::generic_stream::get_input_stream ( )

inlinevirtual

Reimplemented in chomik::generic_stream_file_input, and chomik::generic_stream_stringstream.

get_is_good()

virtual bool chomik::generic_stream::get_is_good ( )

inlinevirtual

Reimplemented in chomik::generic_stream_file_input, chomik::generic_stream_file_output, chomik::generic_stream_standard_input_stream, and chomik::generic_stream_stringstream.

get_output_stream()

virtual std::ostream & chomik::generic_stream::get_output_stream ( )

inlinevirtual

Reimplemented in chomik::generic_stream_file_output, chomik::generic_stream_standard_error_stream, chomik::generic_stream_standard_output_stream, and chomik::generic_stream_stringstream.

get_result()

virtual std::string chomik::generic_stream::get_result ( ) const

inlinevirtual

Reimplemented in chomik::generic_stream_stringstream.

get_should_be_closed()

virtual bool chomik::generic_stream::get_should_be_closed ( ) const

inlinevirtual

Reimplemented in chomik::generic_stream_file_input, and chomik::generic_stream_file_output.

get_should_be_opened()

virtual bool chomik::generic_stream::get_should_be_opened ( ) const

inlinevirtual

Reimplemented in chomik::generic_stream_file_input, and chomik::generic_stream_file_output.

getline()

virtual void chomik::generic_stream::getline ( )

inlinevirtual

Reimplemented in chomik::generic_stream_file_input, chomik::generic_stream_standard_input_stream, and chomik::generic_stream_stringstream.

getline_result()

virtual std::string chomik::generic_stream::getline_result ( ) const

inlinevirtual

Reimplemented in chomik::generic_stream_file_input, chomik::generic_stream_standard_input_stream, and chomik::generic_stream_stringstream.

read_char()

virtual bool chomik::generic_stream::read_char ( unsigned char & target )

inlinevirtual

Reimplemented in chomik::generic_stream_file_input, chomik::generic_stream_standard_input_stream, and chomik::generic_stream_stringstream.

read_integer()

virtual int chomik::generic_stream::read_integer ( )

inlinevirtual

Reimplemented in chomik::generic_stream_file_input, chomik::generic_stream_random_number_stream, chomik::generic_stream_standard_input_stream, and chomik::generic_stream_stringstream.

read_string()

virtual std::string chomik::generic_stream::read_string ( )

inlinevirtual

Reimplemented in chomik::generic_stream_random_enum_stream.

read_string_of_x_characters()

void chomik::generic_stream::read_string_of_x_characters ( std::string & target, unsigned x )

protected

set_max_size()

void chomik::generic_stream::set_max_size ( int ms )

inline

set_result()

virtual void chomik::generic_stream::set_result ( const std::string & r )

inlinevirtual

Reimplemented in chomik::generic_stream_stringstream.

Member Data Documentation

max_size

int chomik::generic_stream::max_size

protected

---

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

• inc/chomik.h