Stream buffering class that performs the magic of indenting data sent to an std::ostream object. More...

#include <Teuchos_FancyOStream_decl.hpp>

Inherits std::basic_streambuf< CharT, Traits >.

Public Types
typedef CharT	char_type

typedef Traits	traits_type

typedef traits_type::int_type	int_type

typedef traits_type::pos_type	pos_type

typedef traits_type::off_type	off_type

Public Member Functions
	basic_FancyOStream_buf (const RCP< std::basic_ostream< char_type, traits_type > > &oStream, const std::basic_string< char_type, traits_type > &tabIndentStr, const int startingTab, const bool showLinePrefix, const int maxLenLinePrefix, const bool showTabCount, const bool showProcRank)

void	initialize (const RCP< std::basic_ostream< char_type, traits_type > > &oStream, const std::basic_string< char_type, traits_type > &tabIndentStr, const int startingTab, const bool showLinePrefix, const int maxLenLinePrefix, const bool showTabCount, const bool showProcRank)

RCP< std::basic_ostream< char_type, traits_type > >	getOStream ()

void	setTabIndentStr (const std::basic_string< char_type, traits_type > &tabIndentStr)

const std::basic_string< char_type, traits_type > &	getTabIndentStr () const

void	setShowLinePrefix (const bool showLinePrefix)

bool	getShowLinePrefix () const

void	setMaxLenLinePrefix (const int maxLenLinePrefix)

int	getMaxLenLinePrefix () const

void	setShowTabCount (const bool showTabCount)

bool	getShowTabCount () const

void	setShowProcRank (const bool showProcRank)

bool	getShowProcRank () const

void	setProcRankAndSize (const int procRank, const int numProcs)
	Set the (MPI) process rank and the number of processes in the communicator.

int	getProcRank () const
	Get the rank of the calling (MPI) process.

int	getNumProcs () const
	Get the number of processes in the communicator.

void	setOutputToRootOnly (const int rootRank)
	Set the stream to print only on the (MPI) process with the given rank.

int	getOutputToRootOnly () const

void	pushTab (const int tabs)
	Push one or more tabs.

int	getNumCurrTabs () const

void	popTab ()
	Pop the current tab.

void	pushLinePrefix (const std::basic_string< char_type, traits_type > &linePrefix)

void	popLinePrefix ()

const std::basic_string< char_type, traits_type > &	getTopLinePrefix () const

void	pushDisableTabbing ()

void	popDisableTabbing ()

Protected overridden functions from std::basic_streambuf
std::streamsize	xsputn (const char_type *s, std::streamsize n)

int_type	overflow (int_type c)

Detailed Description

template<typename CharT, typename Traits>
class Teuchos::basic_FancyOStream_buf< CharT, Traits >

Stream buffering class that performs the magic of indenting data sent to an std::ostream object.

Note, this is not a user-level class. Users should use basic_FancyOStream.

Definition at line 31 of file Teuchos_FancyOStream_decl.hpp.

Member Typedef Documentation

◆ char_type

template<typename CharT , typename Traits >

typedef CharT Teuchos::basic_FancyOStream_buf< CharT, Traits >::char_type

Definition at line 36 of file Teuchos_FancyOStream_decl.hpp.

◆ traits_type

template<typename CharT , typename Traits >

typedef Traits Teuchos::basic_FancyOStream_buf< CharT, Traits >::traits_type

Definition at line 38 of file Teuchos_FancyOStream_decl.hpp.

◆ int_type

template<typename CharT , typename Traits >

typedef traits_type::int_type Teuchos::basic_FancyOStream_buf< CharT, Traits >::int_type

Definition at line 40 of file Teuchos_FancyOStream_decl.hpp.

◆ pos_type

template<typename CharT , typename Traits >

typedef traits_type::pos_type Teuchos::basic_FancyOStream_buf< CharT, Traits >::pos_type

Definition at line 42 of file Teuchos_FancyOStream_decl.hpp.

◆ off_type

template<typename CharT , typename Traits >

typedef traits_type::off_type Teuchos::basic_FancyOStream_buf< CharT, Traits >::off_type

Definition at line 44 of file Teuchos_FancyOStream_decl.hpp.

Constructor & Destructor Documentation

◆ basic_FancyOStream_buf()

template<typename CharT , typename Traits >

Teuchos::basic_FancyOStream_buf< CharT, Traits >::basic_FancyOStream_buf	(	const RCP< std::basic_ostream< char_type, traits_type > > &	oStream,
		const std::basic_string< char_type, traits_type > &	tabIndentStr,
		const int	startingTab,
		const bool	showLinePrefix,
		const int	maxLenLinePrefix,
		const bool	showTabCount,
		const bool	showProcRank
	)

Definition at line 96 of file Teuchos_FancyOStream_def.hpp.

Member Function Documentation

◆ initialize()

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream_buf< CharT, Traits >::initialize	(	const RCP< std::basic_ostream< char_type, traits_type > > &	oStream,
		const std::basic_string< char_type, traits_type > &	tabIndentStr,
		const int	startingTab,
		const bool	showLinePrefix,
		const int	maxLenLinePrefix,
		const bool	showTabCount,
		const bool	showProcRank
	)

Definition at line 112 of file Teuchos_FancyOStream_def.hpp.

◆ getOStream()

template<typename CharT , typename Traits >

RCP< std::basic_ostream< CharT, Traits > > Teuchos::basic_FancyOStream_buf< CharT, Traits >::getOStream ( )

Definition at line 143 of file Teuchos_FancyOStream_def.hpp.

◆ setTabIndentStr()

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream_buf< CharT, Traits >::setTabIndentStr ( const std::basic_string< char_type, traits_type > & tabIndentStr )

Definition at line 150 of file Teuchos_FancyOStream_def.hpp.

◆ getTabIndentStr()

template<typename CharT , typename Traits >

const std::basic_string< CharT, Traits > & Teuchos::basic_FancyOStream_buf< CharT, Traits >::getTabIndentStr ( ) const

Definition at line 160 of file Teuchos_FancyOStream_def.hpp.

◆ setShowLinePrefix()

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream_buf< CharT, Traits >::setShowLinePrefix ( const bool showLinePrefix )

Definition at line 167 of file Teuchos_FancyOStream_def.hpp.

◆ getShowLinePrefix()

template<typename CharT , typename Traits >

bool Teuchos::basic_FancyOStream_buf< CharT, Traits >::getShowLinePrefix ( ) const

Definition at line 174 of file Teuchos_FancyOStream_def.hpp.

◆ setMaxLenLinePrefix()

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream_buf< CharT, Traits >::setMaxLenLinePrefix ( const int maxLenLinePrefix )

Definition at line 181 of file Teuchos_FancyOStream_def.hpp.

◆ getMaxLenLinePrefix()

template<typename CharT , typename Traits >

int Teuchos::basic_FancyOStream_buf< CharT, Traits >::getMaxLenLinePrefix ( ) const

Definition at line 189 of file Teuchos_FancyOStream_def.hpp.

◆ setShowTabCount()

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream_buf< CharT, Traits >::setShowTabCount ( const bool showTabCount )

Definition at line 196 of file Teuchos_FancyOStream_def.hpp.

◆ getShowTabCount()

template<typename CharT , typename Traits >

bool Teuchos::basic_FancyOStream_buf< CharT, Traits >::getShowTabCount ( ) const

Definition at line 203 of file Teuchos_FancyOStream_def.hpp.

◆ setShowProcRank()

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream_buf< CharT, Traits >::setShowProcRank ( const bool showProcRank )

Definition at line 210 of file Teuchos_FancyOStream_def.hpp.

◆ getShowProcRank()

template<typename CharT , typename Traits >

bool Teuchos::basic_FancyOStream_buf< CharT, Traits >::getShowProcRank ( ) const

Definition at line 217 of file Teuchos_FancyOStream_def.hpp.

◆ setProcRankAndSize()

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream_buf< CharT, Traits >::setProcRankAndSize	(	const int	procRank,
		const int	numProcs
	)

Set the (MPI) process rank and the number of processes in the communicator.

Parameters

procRank	[in] The rank of the calling process.
numProcs	[in] The number of processes in the communicator.

You must call this method before you may call setOutputToRootOnly().

Definition at line 224 of file Teuchos_FancyOStream_def.hpp.

◆ getProcRank()

template<typename CharT , typename Traits >

int Teuchos::basic_FancyOStream_buf< CharT, Traits >::getProcRank ( ) const

Get the rank of the calling (MPI) process.

Precondition: The calling process rank and the number of processes in the communicator were set via a call to setProcRankAndSize().

Definition at line 234 of file Teuchos_FancyOStream_def.hpp.

◆ getNumProcs()

template<typename CharT , typename Traits >

int Teuchos::basic_FancyOStream_buf< CharT, Traits >::getNumProcs ( ) const

Get the number of processes in the communicator.

Precondition: The calling process rank and the number of processes in the communicator were set via a call to setProcRankAndSize().

Definition at line 241 of file Teuchos_FancyOStream_def.hpp.

◆ setOutputToRootOnly()

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream_buf< CharT, Traits >::setOutputToRootOnly ( const int rootRank )

Set the stream to print only on the (MPI) process with the given rank.

Precondition: The calling process rank and the number of processes in the communicator were set via a call to setProcRankAndSize().

Parameters

rootRank [in] The rank of the process on which to print. The convention is to use Process 0 as the "root" process, but this is not required.

Warning: The effect of this method is currently irreversible. This commits downstream users of this output stream to the same assignment of ranks to processes. The result of calling setProcRankAndSize() after this method has been called is undefined. It will likely have no effect.

Definition at line 248 of file Teuchos_FancyOStream_def.hpp.

◆ getOutputToRootOnly()

template<typename CharT , typename Traits >

int Teuchos::basic_FancyOStream_buf< CharT, Traits >::getOutputToRootOnly ( ) const

Definition at line 272 of file Teuchos_FancyOStream_def.hpp.

◆ pushTab()

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream_buf< CharT, Traits >::pushTab ( const int tabs )

Push one or more tabs.

Users should generally not call this method directly. It is better to use OSTab to automate the process. OSTab's constructor calls pushTab() for you. It also calls popTab() automatically on scope exit, whether the scope was exited normally or by an exception throw. This "puts things back how you found them."

Definition at line 279 of file Teuchos_FancyOStream_def.hpp.

◆ getNumCurrTabs()

template<typename CharT , typename Traits >

int Teuchos::basic_FancyOStream_buf< CharT, Traits >::getNumCurrTabs ( ) const

Definition at line 293 of file Teuchos_FancyOStream_def.hpp.

◆ popTab()

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream_buf< CharT, Traits >::popTab ( )

Pop the current tab.

Users should generally not call this method directly. It is better to use OSTab to automate the process. OSTab calls popTab() automatically on scope exit, whether the scope was exited normally or by an exception throw. This "puts things back how you found them."

Definition at line 300 of file Teuchos_FancyOStream_def.hpp.