libMesh::BasicOStreamProxy< charT, traits > Class Template Reference

This class is intended to be reseatable like a pointer-to-ostream for flexibility, but to look like a reference when used to produce less awkward user code. More...

#include <ostream_proxy.h>

Public Types
typedef std::basic_ostream< charT, traits >	streamT
	This class is going to be used to proxy for ostream, but other character and traits types are possible. More...
typedef std::basic_streambuf< charT, traits >	streambufT
	This class is going to be used to proxy for ostream, but other character and traits types are possible. More...

Public Member Functions
	BasicOStreamProxy (streamT &target)
	Default constructor. More...
	BasicOStreamProxy (BasicOStreamProxy &old)
	Shallow copy constructor. More...
BasicOStreamProxy &	operator= (streamT &target)
	Reset the internal target to a new target output stream. More...
BasicOStreamProxy &	operator= (const BasicOStreamProxy &old)
	Reset the target to the same output stream as in old. More...
	~BasicOStreamProxy ()=default
	Default destructor. More...
	operator streamT & ()
	Conversion to ostream &, for when we get passed to a function requesting one. More...
	operator const streamT & () const
	Conversion to const ostream &, for when we get passed to a function requesting one. More...
template<typename T >
BasicOStreamProxy &	operator<< (const T &in)
	Redirect any output to the target. More...
BasicOStreamProxy &	operator<< (streamT &(*in)(streamT &))
	Redirect any ostream manipulators to the target. More...
BasicOStreamProxy &	operator<< (std::basic_ios< charT, traits > &(*in)(std::basic_ios< charT, traits > &))
	Redirect any ios manipulators to the target. More...
BasicOStreamProxy &	operator<< (std::ios_base &(*in)(std::ios_base &))
	Redirect any ios_base manipulators to the target. More...
streambufT *	rdbuf () const
	Get the associated stream buffer. More...
streambufT *	rdbuf (streambufT *sb)
	Set the associated stream buffer. More...
BasicOStreamProxy &	flush ()
	Flush the associated stream buffer. More...
std::ios_base::fmtflags	flags () const
	Get the associated format flags. More...
std::ios_base::fmtflags	flags (std::ios_base::fmtflags fmtfl)
	Set/get the associated format flags. More...
std::ios_base::fmtflags	setf (std::ios_base::fmtflags fmtfl)
	Set the associated flags. More...
std::ios_base::fmtflags	setf (std::ios_base::fmtflags fmtfl, std::ios_base::fmtflags mask)
	Set the associated flags. More...
void	unsetf (std::ios_base::fmtflags mask)
	Clear the associated flags. More...
std::streamsize	precision () const
	Get the associated write precision. More...
std::streamsize	precision (std::streamsize prec)
	Set the associated write precision. More...
void	reset (streamT &target)
	Reset the proxy to point to a different target. More...
streamT *	get ()
	Rather than implement every ostream/ios/ios_base function, we'll be lazy and make esoteric uses go through a get() function. More...
const streamT *	get () const
	Rather than implement every ostream/ios/ios_base function, we'll be lazy and make esoteric uses go through a get() function. More...
std::streampos	tellp ()
	Returns the position of the character in the current stream. More...

Private Attributes
streamT *	_target
	The pointer to the "real" ostream we send everything to. More...

Detailed Description

template<typename charT = char, typename traits = std::char_traits<charT>>
class libMesh::BasicOStreamProxy< charT, traits >

This class is intended to be reseatable like a pointer-to-ostream for flexibility, but to look like a reference when used to produce less awkward user code.

It is up to the user to ensure that the target ostream remains valid.

Author

Roy Stogner

Date

2010

Definition at line 42 of file ostream_proxy.h.

Member Typedef Documentation

streambufT

template<typename charT = char, typename traits = std::char_traits<charT>>

typedef std::basic_streambuf<charT,traits> libMesh::BasicOStreamProxy< charT, traits >::streambufT

This class is going to be used to proxy for ostream, but other character and traits types are possible.

Definition at line 55 of file ostream_proxy.h.

streamT

template<typename charT = char, typename traits = std::char_traits<charT>>

typedef std::basic_ostream<charT,traits> libMesh::BasicOStreamProxy< charT, traits >::streamT

This class is going to be used to proxy for ostream, but other character and traits types are possible.

Definition at line 49 of file ostream_proxy.h.

Constructor & Destructor Documentation

BasicOStreamProxy() [1/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

libMesh::BasicOStreamProxy< charT, traits >::BasicOStreamProxy ( streamT &  target )

inline

Default constructor.

Takes a reference to the target ostream to which we pass output. The user is responsible for ensuring that this target exists for as long as the proxy does.

Definition at line 62 of file ostream_proxy.h.

: _target(&target) {}

BasicOStreamProxy() [2/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

libMesh::BasicOStreamProxy< charT, traits >::BasicOStreamProxy ( BasicOStreamProxy< charT, traits > &  old )

inline

Shallow copy constructor.

Output in the new object is passed to the same target ostream as in the old object. The user is responsible for ensuring that this target exists for as long as the proxies do.

Definition at line 70 of file ostream_proxy.h.

: _target(old._target) {}

~BasicOStreamProxy()

template<typename charT = char, typename traits = std::char_traits<charT>>

libMesh::BasicOStreamProxy< charT, traits >::~BasicOStreamProxy ( )

default

Default destructor.

Member Function Documentation

flags() [1/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

std::ios_base::fmtflags libMesh::BasicOStreamProxy< charT, traits >::flags ( ) const

inline

Get the associated format flags.

Definition at line 162 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

Referenced by main().

  { return _target->flags(); }

flags() [2/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

std::ios_base::fmtflags libMesh::BasicOStreamProxy< charT, traits >::flags ( std::ios_base::fmtflags  fmtfl )

inline

Set/get the associated format flags.

Definition at line 168 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

  { return _target->flags(fmtfl); }

flush()

template<typename charT = char, typename traits = std::char_traits<charT>>

BasicOStreamProxy& libMesh::BasicOStreamProxy< charT, traits >::flush ( )

inline

Flush the associated stream buffer.

Definition at line 157 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

Referenced by assemble_ellipticdg(), and libMesh::PltLoader::read_data().

{ _target->flush(); return *this; }

get() [1/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

streamT* libMesh::BasicOStreamProxy< charT, traits >::get ( )

inline

Rather than implement every ostream/ios/ios_base function, we'll be lazy and make esoteric uses go through a get() function.

Definition at line 217 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

Referenced by libMesh::ReferenceCounter::increment_constructor_count(), libMesh::ReferenceCounter::increment_destructor_count(), and libMesh::LibMeshInit::~LibMeshInit().

  {
    return _target;
  }

get() [2/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

const streamT* libMesh::BasicOStreamProxy< charT, traits >::get ( ) const

inline

Rather than implement every ostream/ios/ios_base function, we'll be lazy and make esoteric uses go through a get() function.

Definition at line 226 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

  {
    return _target;
  }

operator const streamT &()

template<typename charT = char, typename traits = std::char_traits<charT>>

libMesh::BasicOStreamProxy< charT, traits >::operator const streamT & ( ) const

inline

Conversion to const ostream &, for when we get passed to a function requesting one.

Definition at line 109 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

{ return *_target; }

operator streamT &()

template<typename charT = char, typename traits = std::char_traits<charT>>

libMesh::BasicOStreamProxy< charT, traits >::operator streamT & ( )

inline

Conversion to ostream &, for when we get passed to a function requesting one.

Definition at line 103 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

{ return *_target; }

operator<<() [1/4]

template<typename charT = char, typename traits = std::char_traits<charT>>

template<typename T >

BasicOStreamProxy& libMesh::BasicOStreamProxy< charT, traits >::operator<< ( const T &  in )

inline

Redirect any output to the target.

Definition at line 115 of file ostream_proxy.h.

  {
    (*_target) << in; return *this;
  }

operator<<() [2/4]

template<typename charT = char, typename traits = std::char_traits<charT>>

BasicOStreamProxy& libMesh::BasicOStreamProxy< charT, traits >::operator<< ( streamT &(*)(streamT &)  in )

inline

Redirect any ostream manipulators to the target.

Definition at line 123 of file ostream_proxy.h.

  {
    (*_target) << in; return *this;
  }

operator<<() [3/4]

template<typename charT = char, typename traits = std::char_traits<charT>>

BasicOStreamProxy& libMesh::BasicOStreamProxy< charT, traits >::operator<< ( std::basic_ios< charT, traits > &(*)(std::basic_ios< charT, traits > &)  in )

inline

Redirect any ios manipulators to the target.

Definition at line 131 of file ostream_proxy.h.

  {
    (*_target) << in; return *this;
  }

operator<<() [4/4]

template<typename charT = char, typename traits = std::char_traits<charT>>

BasicOStreamProxy& libMesh::BasicOStreamProxy< charT, traits >::operator<< ( std::ios_base &(*)(std::ios_base &)  in )

inline

Redirect any ios_base manipulators to the target.

Definition at line 139 of file ostream_proxy.h.

  {
    (*_target) << in; return *this;
  }

operator=() [1/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

BasicOStreamProxy& libMesh::BasicOStreamProxy< charT, traits >::operator= ( streamT &  target )

inline

Reset the internal target to a new target output stream.

Definition at line 75 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

  {
    _target = ⌖
    return *this;
  }

operator=() [2/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

BasicOStreamProxy& libMesh::BasicOStreamProxy< charT, traits >::operator= ( const BasicOStreamProxy< charT, traits > &  old )

inline

Reset the target to the same output stream as in old.

Definition at line 84 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

  {
    _target = old._target;
    return *this;
  }

precision() [1/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

std::streamsize libMesh::BasicOStreamProxy< charT, traits >::precision ( ) const

inline

Get the associated write precision.

Definition at line 193 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

Referenced by libMesh::FEMSystem::assembly(), libMesh::ContinuationSystem::continuation_solve(), main(), and libMesh::ContinuationSystem::update_solution().

  { return _target->precision(); }

precision() [2/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

std::streamsize libMesh::BasicOStreamProxy< charT, traits >::precision ( std::streamsize  prec )

inline

Set the associated write precision.

Definition at line 199 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

  { return _target->precision(prec); }

rdbuf() [1/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

streambufT* libMesh::BasicOStreamProxy< charT, traits >::rdbuf ( ) const

inline

Get the associated stream buffer.

Definition at line 147 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

Referenced by main(), StreamRedirector::StreamRedirector(), libMesh::LibMeshInit::~LibMeshInit(), and StreamRedirector::~StreamRedirector().

{ return _target->rdbuf(); }

rdbuf() [2/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

streambufT* libMesh::BasicOStreamProxy< charT, traits >::rdbuf ( streambufT *  sb )

inline

Set the associated stream buffer.

Definition at line 152 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

{ return _target->rdbuf(sb); }

reset()

template<typename charT = char, typename traits = std::char_traits<charT>>

void libMesh::BasicOStreamProxy< charT, traits >::reset ( streamT &  target )

inline

Reset the proxy to point to a different target.

Note

This does not delete the previous target.

Definition at line 211 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

Referenced by libMesh::LibMeshInit::~LibMeshInit().

{ _target = ⌖ }

setf() [1/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

std::ios_base::fmtflags libMesh::BasicOStreamProxy< charT, traits >::setf ( std::ios_base::fmtflags  fmtfl )

inline

Set the associated flags.

Definition at line 174 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

Referenced by libMesh::ContinuationSystem::continuation_solve(), and libMesh::ContinuationSystem::update_solution().

  { return _target->setf(fmtfl); }

setf() [2/2]

template<typename charT = char, typename traits = std::char_traits<charT>>

std::ios_base::fmtflags libMesh::BasicOStreamProxy< charT, traits >::setf ( std::ios_base::fmtflags  fmtfl, std::ios_base::fmtflags  mask  )

inline

Set the associated flags.

Definition at line 180 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

  { return _target->setf(fmtfl, mask); }

tellp()

template<typename charT = char, typename traits = std::char_traits<charT>>

std::streampos libMesh::BasicOStreamProxy< charT, traits >::tellp ( )

inline

Returns the position of the character in the current stream.

Definition at line 234 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

{ return _target->tellp(); }

unsetf()

template<typename charT = char, typename traits = std::char_traits<charT>>

void libMesh::BasicOStreamProxy< charT, traits >::unsetf ( std::ios_base::fmtflags  mask )

inline

Clear the associated flags.

Definition at line 187 of file ostream_proxy.h.

References libMesh::BasicOStreamProxy< charT, traits >::_target.

Referenced by libMesh::ContinuationSystem::continuation_solve(), and libMesh::ContinuationSystem::update_solution().

  { _target->unsetf(mask); }

Member Data Documentation

_target

template<typename charT = char, typename traits = std::char_traits<charT>>

streamT* libMesh::BasicOStreamProxy< charT, traits >::_target

private

The pointer to the "real" ostream we send everything to.

Definition at line 240 of file ostream_proxy.h.

Referenced by libMesh::BasicOStreamProxy< charT, traits >::flags(), libMesh::BasicOStreamProxy< charT, traits >::flush(), libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::BasicOStreamProxy< charT, traits >::operator const streamT &(), libMesh::BasicOStreamProxy< charT, traits >::operator streamT &(), libMesh::BasicOStreamProxy< charT, traits >::operator=(), libMesh::BasicOStreamProxy< charT, traits >::precision(), libMesh::BasicOStreamProxy< charT, traits >::rdbuf(), libMesh::BasicOStreamProxy< charT, traits >::reset(), libMesh::BasicOStreamProxy< charT, traits >::setf(), libMesh::BasicOStreamProxy< charT, traits >::tellp(), and libMesh::BasicOStreamProxy< charT, traits >::unsetf().

---

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

• include/utils/ostream_proxy.h