std::ostream subclass that performs the magic of indenting data sent to an std::ostream object among other things. More...

#include <Teuchos_FancyOStream.hpp>

Private Member Functions
	basic_FancyOStream ()
	basic_FancyOStream (const basic_FancyOStream< CharT, Traits > &)
basic_FancyOStream< CharT, Traits >	operator= (const basic_FancyOStream< CharT, Traits > &)
Private Attributes
streambuf_t	streambuf_
Related Functions
(Note that these are not member functions.)
RCP< basic_FancyOStream< char > >	fancyOStream (const RCP< std::basic_ostream< char > > &oStream, const std::basic_string< char > &tabIndentStr=" ", const int startingTab=0, const bool showLinePrefix=false, const int maxLenLinePrefix=10, const bool showTabCount=false, const bool showProcRank=false)
	Dynamically allocate a FancyOStream and return it wrapped in an RCP object.
RCP< basic_FancyOStream< char > >	getFancyOStream (const RCP< std::basic_ostream< char > > &out)
	Get a FancyOStream from an std::ostream object.
template<typename CharT , typename Traits >
RCP< basic_FancyOStream< CharT, Traits > >	tab (const RCP< basic_FancyOStream< CharT, Traits > > &out, const int tabs=1, const std::basic_string< CharT, Traits > linePrefix="")
	Create a tab for an RCP-wrapped `basic_FancyOStream` object to cause the indentation of all output automatically!.
template<typename CharT , typename Traits >
RCP< basic_FancyOStream< CharT, Traits > >	tab (const RCP< std::basic_ostream< CharT, Traits > > &out, const int tabs=1, const std::basic_string< CharT, Traits > linePrefix="")
	Create a tab for an RCP-wrapped `std:: std::ostream` object to cause the indentation of all output automatically!.
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

typedef basic_FancyOStream_buf < CharT, Traits >	streambuf_t
typedef std::basic_ostream < char_type, traits_type >	ostream_t

Public client functions
	basic_FancyOStream (const RCP< std::basic_ostream< char_type, traits_type > > &oStream, const std::basic_string< char_type, traits_type > &tabIndentStr=" ", const int startingTab=0, const bool showLinePrefix=false, const int maxLenLinePrefix=10, const bool showTabCount=false, const bool showProcRank=false)

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

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

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

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

basic_FancyOStream &	setShowAllFrontMatter (const bool showAllFrontMatter)
	Set if processor rank, line prefixes, and tab counts are shown or not .
basic_FancyOStream &	setShowLinePrefix (const bool showLinePrefix)

basic_FancyOStream &	setMaxLenLinePrefix (const int maxLenLinePrefix)

basic_FancyOStream &	setShowTabCount (const bool showTabCount)

basic_FancyOStream &	setShowProcRank (const bool showProcRank)

basic_FancyOStream &	setProcRankAndSize (const int procRank, const int numProcs)

basic_FancyOStream &	setOutputToRootOnly (const int rootRank)

int	getOutputToRootOnly () const

void	copyAllOutputOptions (const basic_FancyOStream< CharT, Traits > &oStream)

Functions designed to be used by basic_OSTab
void	pushTab (const int tabs=1)

int	getNumCurrTabs () const

void	popTab ()

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 ()

Detailed Description

template<typename CharT, typename Traits = std::char_traits<CharT>>
class Teuchos::basic_FancyOStream< CharT, Traits >

std::ostream subclass that performs the magic of indenting data sent to an std::ostream object among other things.

Use the typedef FancyOStream for support for the char character type.

Indentation of the stream is accomplished through creating basic_OSTab objects.

In addition to indenting output, this stream object can also print various types of information at the beginning of each line. The type of information supported is:

Processor rank: Set using setShowProcRank().
Line prefix name: Set using showLinePrefix() and OSTab::OSTab().
Tab counts (useful for debugging): Set using setShowTabCount().

See FancyOutputting_test.cpp for examples of how this class is used and the output it generates.

Definition at line 321 of file Teuchos_FancyOStream.hpp.

Member Typedef Documentation

template<typename CharT, typename Traits = std::char_traits<CharT>>

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

Definition at line 329 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits = std::char_traits<CharT>>

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

Definition at line 331 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits = std::char_traits<CharT>>

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

Definition at line 333 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits = std::char_traits<CharT>>

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

Definition at line 335 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits = std::char_traits<CharT>>

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

Definition at line 337 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits = std::char_traits<CharT>>

typedef basic_FancyOStream_buf<CharT,Traits> Teuchos::basic_FancyOStream< CharT, Traits >::streambuf_t

Definition at line 341 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits = std::char_traits<CharT>>

typedef std::basic_ostream<char_type, traits_type> Teuchos::basic_FancyOStream< CharT, Traits >::ostream_t

Definition at line 343 of file Teuchos_FancyOStream.hpp.

Constructor & Destructor Documentation

template<typename CharT , typename Traits >

Teuchos::basic_FancyOStream< CharT, Traits >::basic_FancyOStream	(	const RCP< std::basic_ostream< char_type, traits_type > > &	oStream,
		const std::basic_string< char_type, traits_type > &	tabIndentStr = `" "`,
		const int	startingTab = `0`,
		const bool	showLinePrefix = `false`,
		const int	maxLenLinePrefix = `10`,
		const bool	showTabCount = `false`,
		const bool	showProcRank = `false`
	)		`[explicit]`

Definition at line 1126 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits = std::char_traits<CharT>>

Teuchos::basic_FancyOStream< CharT, Traits >::basic_FancyOStream ( ) [private]

template<typename CharT, typename Traits = std::char_traits<CharT>>

Teuchos::basic_FancyOStream< CharT, Traits >::basic_FancyOStream ( const basic_FancyOStream< CharT, Traits > & ) [private]

Member Function Documentation

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream< 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 = `0`,
		const bool	showLinePrefix = `false`,
		const int	maxLenLinePrefix = `10`,
		const bool	showTabCount = `false`,
		const bool	showProcRank = `false`
	)

Definition at line 1144 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

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

Definition at line 1162 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

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

Definition at line 1170 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

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

Definition at line 1181 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setShowAllFrontMatter ( const bool showAllFrontMatter )

Set if processor rank, line prefixes, and tab counts are shown or not .

Definition at line 1189 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setShowLinePrefix ( const bool showLinePrefix )

Definition at line 1202 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setMaxLenLinePrefix ( const int maxLenLinePrefix )

Definition at line 1211 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setShowTabCount ( const bool showTabCount )

Definition at line 1220 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setShowProcRank ( const bool showProcRank )

Definition at line 1229 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setProcRankAndSize	(	const int	procRank,
		const int	numProcs
	)

Definition at line 1238 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setOutputToRootOnly ( const int rootRank )

Definition at line 1247 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

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

Definition at line 1255 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream< CharT, Traits >::copyAllOutputOptions ( const basic_FancyOStream< CharT, Traits > & oStream )

Definition at line 1262 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream< CharT, Traits >::pushTab ( const int tabs = 1 )

Definition at line 1277 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

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

Definition at line 1284 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

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

Definition at line 1291 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream< CharT, Traits >::pushLinePrefix ( const std::basic_string< char_type, traits_type > & linePrefix )

Definition at line 1298 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream< CharT, Traits >::popLinePrefix ( )

Definition at line 1307 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

const std::basic_string< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::getTopLinePrefix ( ) const

Definition at line 1315 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream< CharT, Traits >::pushDisableTabbing ( )

Definition at line 1322 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

void Teuchos::basic_FancyOStream< CharT, Traits >::popDisableTabbing ( )

Definition at line 1329 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits = std::char_traits<CharT>>

basic_FancyOStream<CharT,Traits> Teuchos::basic_FancyOStream< CharT, Traits >::operator= ( const basic_FancyOStream< CharT, Traits > & ) [private]

Friends And Related Function Documentation

template<typename CharT, typename Traits = std::char_traits<CharT>>

RCP< basic_FancyOStream< char > > fancyOStream	(	const RCP< std::basic_ostream< char > > &	oStream,
		const std::basic_string< char > &	tabIndentStr = `" "`,
		const int	startingTab = `0`,
		const bool	showLinePrefix = `false`,
		const int	maxLenLinePrefix = `10`,
		const bool	showTabCount = `false`,
		const bool	showProcRank = `false`
	)		`[related]`

Dynamically allocate a FancyOStream and return it wrapped in an RCP object.

Returns a null object if the input stream is null.

Definition at line 463 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits = std::char_traits<CharT>>

RCP< basic_FancyOStream< char > > getFancyOStream ( const RCP< std::basic_ostream< char > > & out ) [related]

Get a FancyOStream from an std::ostream object.

If the object already is a FancyOStream, then nothing has to be done. Otherwise, a temp FancyOStream is created for this purpose. If out.get()==NULL then return.get()==NULL on return also!

Definition at line 495 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

RCP< basic_FancyOStream< CharT, Traits > > tab	(	const RCP< basic_FancyOStream< CharT, Traits > > &	out,
		const int	tabs = `1`,
		const std::basic_string< CharT, Traits >	linePrefix = `""`
	)		`[related]`

Create a tab for an RCP-wrapped basic_FancyOStream object to cause the indentation of all output automatically!.

This function returns an RCP object to a basic_FancyOStream object that has its tab indented by one. If the input *out object is already a basic_FancyOStream object, then that object is used as is. If the *out object is not a basic_FancyOStream object, then a new basic_FancyOStream object is created and its tab is set!"

In any case, when the returned RCP object is destroyed, the tab will be removed automatically!

Definition at line 657 of file Teuchos_FancyOStream.hpp.

template<typename CharT , typename Traits >

RCP< basic_FancyOStream< CharT, Traits > > tab	(	const RCP< std::basic_ostream< CharT, Traits > > &	out,
		const int	tabs = `1`,
		const std::basic_string< CharT, Traits >	linePrefix = `""`
	)		`[related]`

Create a tab for an RCP-wrapped std:: std::ostream object to cause the indentation of all output automatically!.

This function returns an RCP object to a basic_FancyOStream object that has its tab indented by one. If the input *out object is already a basic_FancyOStream object, then that object is used as is. If the *out object is not a basic_FancyOStream object, then a new basic_FancyOStream object is created and its tab is set!"

In any case, when the returned RCP object is destroyed, the tab will be removed automatically!

Definition at line 694 of file Teuchos_FancyOStream.hpp.

Member Data Documentation

template<typename CharT, typename Traits = std::char_traits<CharT>>

streambuf_t Teuchos::basic_FancyOStream< CharT, Traits >::streambuf_ [private]

Definition at line 444 of file Teuchos_FancyOStream.hpp.

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

Teuchos_FancyOStream.hpp

Private Member Functions

Private Attributes

Related Functions

Public types

Public client functions

Functions designed to be used by basic_OSTab

Detailed Description

template<typename CharT, typename Traits = std::char_traits<CharT>> class Teuchos::basic_FancyOStream< CharT, Traits >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename CharT, typename Traits = std::char_traits<CharT>>
class Teuchos::basic_FancyOStream< CharT, Traits >