Rosetta
Public Member Functions | Private Attributes | List of all members
utility::io::ocstream Class Reference

ocstream: Output channel stream wrapper class More...

#include <ocstream.hh>

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

Public Member Functions

 ocstream (std::ostream &o_stream_a)
 Constructor. More...
 
 ~ocstream () override
 Destructor. More...
 
 operator bool () const override
 bool conversion More...
 
 operator std::ostream const & () const override
 Stream conversion. More...
 
 operator std::ostream & () override
 Stream conversion. More...
 
template<typename T >
ocstreamoperator<< (T const &t)
 Stream output: override to preserve type of return value. More...
 
ocstreamoperator<< (manipulator m) override
 Stream manipulator output. More...
 
ocstreamput (char const c) override
 Write a char. More...
 
ocstreamwrite (char const *str, std::streamsize const count) override
 Write a string. More...
 
ocstreamwrite (std::string const &str, std::streamsize const count) override
 Write a string. More...
 
ocstreamflush () override
 Flush the stream. More...
 
void clear () override
 Clear the stream. More...
 
std::ostream const & operator() () const override
 Stream access. More...
 
std::ostream & operator() () override
 Stream access. More...
 
std::ostream const & stream () const override
 Stream access. More...
 
std::ostream & 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::orstream
virtual ~orstream ()
 Destructor. More...
 
template<typename T >
orstreamoperator<< (T const &t)
 Stream output. More...
 

Private Attributes

std::ostream & o_stream_
 Output stream reference. More...
 

Additional Inherited Members

- Protected Types inherited from utility::io::orstream
typedef std::ostream &(* manipulator) (std::ostream &)
 
- Protected Member Functions inherited from utility::io::orstream
 orstream ()=default
 Default constructor. More...
 

Detailed Description

ocstream: Output channel stream wrapper class

Constructor & Destructor Documentation

◆ ocstream()

utility::io::ocstream::ocstream ( std::ostream &  o_stream_a)
inline

Constructor.

◆ ~ocstream()

utility::io::ocstream::~ocstream ( )
inlineoverride

Destructor.

Member Function Documentation

◆ bad()

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

Bad?

Implements utility::io::orstream.

References o_stream_.

◆ clear()

void utility::io::ocstream::clear ( )
inlineoverridevirtual

◆ compressed()

bool utility::io::ocstream::compressed ( ) const
inlineoverridevirtual

◆ eof()

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

End of file?

Implements utility::io::orstream.

References o_stream_.

◆ fail()

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

Fail?

Implements utility::io::orstream.

References o_stream_.

◆ flush()

ocstream& utility::io::ocstream::flush ( )
inlineoverridevirtual

◆ good()

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

Good?

Implements utility::io::orstream.

References o_stream_.

◆ gzipped()

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

gzipped?

Implements utility::io::orstream.

◆ operator bool()

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

bool conversion

Implements utility::io::orstream.

References o_stream_.

◆ operator std::ostream &()

utility::io::ocstream::operator std::ostream & ( )
inlineoverridevirtual

Stream conversion.

Implements utility::io::orstream.

References o_stream_.

◆ operator std::ostream const &()

utility::io::ocstream::operator std::ostream const & ( ) const
inlineoverridevirtual

Stream conversion.

Implements utility::io::orstream.

References o_stream_.

◆ operator()() [1/2]

std::ostream const& utility::io::ocstream::operator() ( ) const
inlineoverridevirtual

Stream access.

Implements utility::io::orstream.

References o_stream_.

◆ operator()() [2/2]

std::ostream& utility::io::ocstream::operator() ( )
inlineoverridevirtual

Stream access.

Implements utility::io::orstream.

References o_stream_.

◆ operator<<() [1/2]

ocstream& utility::io::ocstream::operator<< ( manipulator  m)
inlineoverridevirtual

Stream manipulator output.

Implements utility::io::orstream.

References kmeans_adaptive_kernel_density_bb_dependent_rotlib::m, and o_stream_.

◆ operator<<() [2/2]

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

Stream output: override to preserve type of return value.

References o_stream_, and predPRE::t.

◆ put()

ocstream& utility::io::ocstream::put ( char const  c)
inlineoverridevirtual

◆ rdbuf()

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

Pointer to the stream buffer.

Implements utility::io::orstream.

References o_stream_.

Referenced by utility::file::gunzip(), and utility::file::gzip().

◆ stream() [1/2]

std::ostream const& utility::io::ocstream::stream ( ) const
inlineoverridevirtual

Stream access.

Implements utility::io::orstream.

References o_stream_.

◆ stream() [2/2]

std::ostream& utility::io::ocstream::stream ( )
inlineoverridevirtual

Stream access.

Implements utility::io::orstream.

References o_stream_.

◆ uncompressed()

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

Uncompressed?

Implements utility::io::orstream.

◆ write() [1/2]

ocstream& utility::io::ocstream::write ( char const *  str,
std::streamsize const  count 
)
inlineoverridevirtual

Write a string.

Implements utility::io::orstream.

References count, o_stream_, and str().

◆ write() [2/2]

ocstream& utility::io::ocstream::write ( std::string const &  str,
std::streamsize const  count 
)
inlineoverridevirtual

Write a string.

Implements utility::io::orstream.

References count, o_stream_, and str().

Member Data Documentation

◆ o_stream_

std::ostream& utility::io::ocstream::o_stream_
private

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