Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
utility::io::icstream Class Reference

icstream: Input channel stream wrapper class More...

#include <icstream.hh>

Inheritance diagram for utility::io::icstream:
Inheritance graph
[legend]

Public Member Functions

 icstream (std::istream &i_stream_a)
 Constructor. More...
 
 operator bool () const override
 bool conversion More...
 
 operator std::istream const & () const override
 Stream conversion. More...
 
 operator std::istream & () override
 Stream conversion. More...
 
template<typename T >
icstreamoperator>> (T &t)
 Stream input: Override to preserve type of return value. More...
 
std::istream & operator>> (std_manipulator m) override
 Stream manipulator input. More...
 
void seek_beg () override
 Seek to the beginning. More...
 
int get () override
 Get the next character. More...
 
icstreamget (char &c) override
 Get the next character. More...
 
icstreamget (char *str, std::streamsize const count) override
 Get the next specified number of characters. More...
 
icstreamget (char *str, std::streamsize const count, char const delim) override
 Get the next specified number of characters. More...
 
icstreamget (std::string &str, std::streamsize const count) override
 Get the next specified number of characters. More...
 
icstreamget (std::string &str, std::streamsize const count, char const delim) override
 Get the next specified number of characters. More...
 
icstreamgetline (char *line, std::streamsize const count) override
 Get the rest of the line. More...
 
icstreamgetline (char *line, std::streamsize const count, char const delim) override
 Get the rest of the line. More...
 
icstreamgetline (std::string &line) override
 Get the rest of the line. More...
 
icstreamgetline (std::string &line, char const delim) override
 Get the rest of the line. More...
 
icstreamread (char *str, std::streamsize const count) override
 Read the next specified number of characters. More...
 
icstreamread (std::string &str, std::streamsize const count) override
 Read the next specified number of characters. More...
 
std::streamsize readsome (char *str, std::streamsize const count) override
 Read the next available specified number of characters. More...
 
std::streamsize readsome (std::string &str, std::streamsize const count) override
 Read the next available specified number of characters. More...
 
icstreamignore () override
 Skip over the next character. More...
 
icstreamignore (std::streamsize const count) override
 Skip over the next specified number of characters. More...
 
icstreamignore (std::streamsize const count, char const delim) override
 Skip over the next specified number of characters. More...
 
int peek () override
 Returns the next character without extracting it. More...
 
icstreamunget () override
 Put the last character read back into the stream. More...
 
icstreamputback (char c) override
 Put the last character read back into the stream and check that passed character is correct. More...
 
void clear () override
 Clear the stream. More...
 
std::istream const & operator() () const override
 Stream access. More...
 
std::istream & operator() () override
 Stream access. More...
 
std::istream const & stream () const override
 Stream access. More...
 
std::istream & stream () override
 Stream access. More...
 
std::streambuf * rdbuf () const override
 Pointer to the stream buffer. More...
 
bool good () const override
 Good? More...
 
bool eof () const override
 End of file? More...
 
bool fail () const override
 Fail? More...
 
bool bad () const override
 Bad? More...
 
bool compressed () const override
 Compressed? More...
 
bool uncompressed () const override
 Uncompressed? More...
 
bool gzipped () const override
 gzipped? More...
 
- Public Member Functions inherited from utility::io::irstream
virtual ~irstream ()
 Destructor. More...
 
template<typename T >
irstreamoperator>> (T &t)
 Stream input. More...
 

Private Attributes

std::istream & i_stream_
 Input stream reference. More...
 

Additional Inherited Members

- Protected Types inherited from utility::io::irstream
typedef std::istream &(* std_manipulator )(std::istream &)
 
- Protected Member Functions inherited from utility::io::irstream
 irstream ()=default
 Default constructor. More...
 

Detailed Description

icstream: Input channel stream wrapper class

Constructor & Destructor Documentation

utility::io::icstream::icstream ( std::istream &  i_stream_a)
inline

Constructor.

Member Function Documentation

bool utility::io::icstream::bad ( ) const
inlineoverridevirtual

Bad?

Implements utility::io::irstream.

References i_stream_.

void utility::io::icstream::clear ( )
inlineoverridevirtual
bool utility::io::icstream::compressed ( ) const
inlineoverridevirtual

Compressed?

Implements utility::io::irstream.

bool utility::io::icstream::eof ( ) const
inlineoverridevirtual

End of file?

Implements utility::io::irstream.

References i_stream_.

bool utility::io::icstream::fail ( ) const
inlineoverridevirtual

Fail?

Implements utility::io::irstream.

References i_stream_.

int utility::io::icstream::get ( )
inlineoverridevirtual

Get the next character.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::get ( char &  c)
inlineoverridevirtual

Get the next character.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::get ( char *  str,
std::streamsize const  count 
)
inlineoverridevirtual

Get the next specified number of characters.

Implements utility::io::irstream.

References clean_pdb_keep_ligand::count, and stream().

icstream& utility::io::icstream::get ( char *  str,
std::streamsize const  count,
char const  delim 
)
inlineoverridevirtual

Get the next specified number of characters.

Implements utility::io::irstream.

References clean_pdb_keep_ligand::count, and stream().

icstream& utility::io::icstream::get ( std::string &  str,
std::streamsize const  count 
)
inlineoverridevirtual

Get the next specified number of characters.

Implements utility::io::irstream.

References clean_pdb_keep_ligand::count, basic::options::OptionKeys::cp::cp, and stream().

icstream& utility::io::icstream::get ( std::string &  str,
std::streamsize const  count,
char const  delim 
)
inlineoverridevirtual

Get the next specified number of characters.

Implements utility::io::irstream.

References clean_pdb_keep_ligand::count, basic::options::OptionKeys::cp::cp, and stream().

icstream& utility::io::icstream::getline ( char *  line,
std::streamsize const  count 
)
inlineoverridevirtual

Get the rest of the line.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::getline ( char *  line,
std::streamsize const  count,
char const  delim 
)
inlineoverridevirtual

Get the rest of the line.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::getline ( std::string &  line)
inlineoverridevirtual

Get the rest of the line.

Implements utility::io::irstream.

References ObjexxFCL::getline(), and stream().

icstream& utility::io::icstream::getline ( std::string &  line,
char const  delim 
)
inlineoverridevirtual

Get the rest of the line.

Implements utility::io::irstream.

References ObjexxFCL::getline(), and stream().

bool utility::io::icstream::good ( ) const
inlineoverridevirtual

Good?

Implements utility::io::irstream.

References i_stream_.

bool utility::io::icstream::gzipped ( ) const
inlineoverridevirtual

gzipped?

Implements utility::io::irstream.

icstream& utility::io::icstream::ignore ( )
inlineoverridevirtual

Skip over the next character.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::ignore ( std::streamsize const  count)
inlineoverridevirtual

Skip over the next specified number of characters.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::ignore ( std::streamsize const  count,
char const  delim 
)
inlineoverridevirtual

Skip over the next specified number of characters.

Implements utility::io::irstream.

References stream().

utility::io::icstream::operator bool ( ) const
inlineoverridevirtual

bool conversion

Implements utility::io::irstream.

References i_stream_.

utility::io::icstream::operator std::istream & ( )
inlineoverridevirtual

Stream conversion.

Implements utility::io::irstream.

References i_stream_.

utility::io::icstream::operator std::istream const & ( ) const
inlineoverridevirtual

Stream conversion.

Implements utility::io::irstream.

References i_stream_.

std::istream const& utility::io::icstream::operator() ( ) const
inlineoverridevirtual

Stream access.

Implements utility::io::irstream.

References i_stream_.

std::istream& utility::io::icstream::operator() ( )
inlineoverridevirtual

Stream access.

Implements utility::io::irstream.

References i_stream_.

template<typename T >
icstream& utility::io::icstream::operator>> ( T t)
inline

Stream input: Override to preserve type of return value.

References i_stream_, and basic::options::OptionKeys::in::file::t.

std::istream& utility::io::icstream::operator>> ( std_manipulator  m)
inlineoverridevirtual

Stream manipulator input.

Implements utility::io::irstream.

References test.T110_numeric::m.

int utility::io::icstream::peek ( )
inlineoverridevirtual

Returns the next character without extracting it.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::putback ( char  c)
inlineoverridevirtual

Put the last character read back into the stream and check that passed character is correct.

Implements utility::io::irstream.

References stream().

std::streambuf* utility::io::icstream::rdbuf ( ) const
inlineoverridevirtual

Pointer to the stream buffer.

Implements utility::io::irstream.

References i_stream_.

icstream& utility::io::icstream::read ( char *  str,
std::streamsize const  count 
)
inlineoverridevirtual

Read the next specified number of characters.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::read ( std::string &  str,
std::streamsize const  count 
)
inlineoverridevirtual

Read the next specified number of characters.

Implements utility::io::irstream.

References clean_pdb_keep_ligand::count, basic::options::OptionKeys::cp::cp, and stream().

std::streamsize utility::io::icstream::readsome ( char *  str,
std::streamsize const  count 
)
inlineoverridevirtual

Read the next available specified number of characters.

Implements utility::io::irstream.

References stream().

std::streamsize utility::io::icstream::readsome ( std::string &  str,
std::streamsize const  count 
)
inlineoverridevirtual

Read the next available specified number of characters.

Implements utility::io::irstream.

References clean_pdb_keep_ligand::count, basic::options::OptionKeys::cp::cp, and stream().

void utility::io::icstream::seek_beg ( )
inlineoverridevirtual

Seek to the beginning.

Implements utility::io::irstream.

References stream().

std::istream const& utility::io::icstream::stream ( ) const
inlineoverridevirtual

Stream access.

Implements utility::io::irstream.

References i_stream_.

Referenced by get(), getline(), ignore(), peek(), putback(), read(), readsome(), seek_beg(), and unget().

std::istream& utility::io::icstream::stream ( )
inlineoverridevirtual

Stream access.

Implements utility::io::irstream.

References i_stream_.

bool utility::io::icstream::uncompressed ( ) const
inlineoverridevirtual

Uncompressed?

Implements utility::io::irstream.

icstream& utility::io::icstream::unget ( )
inlineoverridevirtual

Put the last character read back into the stream.

Implements utility::io::irstream.

References stream().

Member Data Documentation

std::istream& utility::io::icstream::i_stream_
private

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