Teuchos::basic_OSTab< CharT, Traits > Class Template Reference

Tabbing class for helping to create formated, indented output for a basic_FancyOStream object. More...

#include <Teuchos_FancyOStream.hpp>

List of all members.

Public Member Functions
	basic_OSTab (const RCP< basic_FancyOStream< CharT, Traits > > &fancyOStream, const int tabs=1, const std::basic_string< CharT, Traits > linePrefix="")
	basic_OSTab (const RCP< std::basic_ostream< CharT, Traits > > &oStream, const int tabs=1, const std::basic_string< CharT, Traits > linePrefix="")
	basic_OSTab (basic_FancyOStream< CharT, Traits > &fancyOStream, const int tabs=1, const std::basic_string< CharT, Traits > linePrefix="")
	Warning: Only call this constructor for stack-based object.
	basic_OSTab (std::basic_ostream< CharT, Traits > &oStream, const int tabs=1, const std::basic_string< CharT, Traits > linePrefix="")
	Warning: Only call this constructor for stack-based object.
	basic_OSTab (const basic_OSTab &osTab)
	~basic_OSTab ()
basic_OSTab< CharT, Traits > &	operator= (const basic_OSTab &osTab)
basic_OSTab< CharT, Traits > &	incrTab (const int tabs=1)
basic_FancyOStream< CharT, Traits > &	o () const
basic_FancyOStream< CharT, Traits > *	get () const
Static Public Attributes
static const int	DISABLE_TABBING = -99999
Private Member Functions
void	updateState ()
Private Attributes
RCP< basic_FancyOStream< CharT, Traits > >	fancyOStream_
int	tabs_
std::basic_string< CharT, Traits >	linePrefix_

---

Detailed Description

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

Tabbing class for helping to create formated, indented output for a basic_FancyOStream object.

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

This class is used to create tab indents and set line prefix names for output that is generated by a basic_FancyOStream object.

Definition at line 519 of file Teuchos_FancyOStream.hpp.

---

Constructor & Destructor Documentation

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

Teuchos::basic_OSTab< CharT, Traits >::basic_OSTab	(	const RCP< basic_FancyOStream< CharT, Traits > > &	fancyOStream,
		const int	tabs = 1,
		const std::basic_string< CharT, Traits >	linePrefix = ""
	)		[inline]

Definition at line 526 of file Teuchos_FancyOStream.hpp.

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

Teuchos::basic_OSTab< CharT, Traits >::basic_OSTab	(	const RCP< std::basic_ostream< CharT, Traits > > &	oStream,
		const int	tabs = 1,
		const std::basic_string< CharT, Traits >	linePrefix = ""
	)		[inline]

Definition at line 538 of file Teuchos_FancyOStream.hpp.

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

Teuchos::basic_OSTab< CharT, Traits >::basic_OSTab	(	basic_FancyOStream< CharT, Traits > &	fancyOStream,
		const int	tabs = 1,
		const std::basic_string< CharT, Traits >	linePrefix = ""
	)		[inline]

Warning: Only call this constructor for stack-based object.

Definition at line 550 of file Teuchos_FancyOStream.hpp.

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

Teuchos::basic_OSTab< CharT, Traits >::basic_OSTab	(	std::basic_ostream< CharT, Traits > &	oStream,
		const int	tabs = 1,
		const std::basic_string< CharT, Traits >	linePrefix = ""
	)		[inline]

Warning: Only call this constructor for stack-based object.

Definition at line 562 of file Teuchos_FancyOStream.hpp.

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

Teuchos::basic_OSTab< CharT, Traits >::basic_OSTab

(

const basic_OSTab< CharT, Traits > &

osTab

)

[inline]

Definition at line 574 of file Teuchos_FancyOStream.hpp.

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

Teuchos::basic_OSTab< CharT, Traits >::~basic_OSTab

(

)

[inline]

Definition at line 581 of file Teuchos_FancyOStream.hpp.

---

Member Function Documentation

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

basic_OSTab<CharT,Traits>& Teuchos::basic_OSTab< CharT, Traits >::operator=

(

const basic_OSTab< CharT, Traits > &

osTab

)

[inline]

Definition at line 592 of file Teuchos_FancyOStream.hpp.

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

basic_OSTab<CharT,Traits>& Teuchos::basic_OSTab< CharT, Traits >::incrTab

(

const int

tabs = 1

)

[inline]

Definition at line 600 of file Teuchos_FancyOStream.hpp.

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

basic_FancyOStream<CharT,Traits>& Teuchos::basic_OSTab< CharT, Traits >::o

(

)

const [inline]

Definition at line 610 of file Teuchos_FancyOStream.hpp.

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

basic_FancyOStream<CharT,Traits>* Teuchos::basic_OSTab< CharT, Traits >::get

(

)

const [inline]

Definition at line 615 of file Teuchos_FancyOStream.hpp.

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

void Teuchos::basic_OSTab< CharT, Traits >::updateState

(

)

[inline, private]

Definition at line 626 of file Teuchos_FancyOStream.hpp.

---

Member Data Documentation

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

const int Teuchos::basic_OSTab< CharT, Traits >::DISABLE_TABBING = -99999 [static]

Definition at line 524 of file Teuchos_FancyOStream.hpp.

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

RCP<basic_FancyOStream<CharT,Traits> > Teuchos::basic_OSTab< CharT, Traits >::fancyOStream_ [private]

Definition at line 622 of file Teuchos_FancyOStream.hpp.

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

int Teuchos::basic_OSTab< CharT, Traits >::tabs_ [private]

Definition at line 623 of file Teuchos_FancyOStream.hpp.

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

std::basic_string<CharT,Traits> Teuchos::basic_OSTab< CharT, Traits >::linePrefix_ [private]

Definition at line 624 of file Teuchos_FancyOStream.hpp.

---

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

• Teuchos_FancyOStream.hpp