Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
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_decl.hpp>

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
 

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.

Examples
ArrayRCP_test.cpp, and FancyOutputting_test.cpp.

Definition at line 599 of file Teuchos_FancyOStream_decl.hpp.

Constructor & Destructor Documentation

◆ basic_OSTab() [1/5]

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 606 of file Teuchos_FancyOStream_decl.hpp.

◆ basic_OSTab() [2/5]

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 618 of file Teuchos_FancyOStream_decl.hpp.

◆ basic_OSTab() [3/5]

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 630 of file Teuchos_FancyOStream_decl.hpp.

◆ basic_OSTab() [4/5]

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 642 of file Teuchos_FancyOStream_decl.hpp.

◆ basic_OSTab() [5/5]

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 654 of file Teuchos_FancyOStream_decl.hpp.

◆ ~basic_OSTab()

template<typename CharT , typename Traits = std::char_traits<CharT>>
Teuchos::basic_OSTab< CharT, Traits >::~basic_OSTab ( )
inline

Definition at line 661 of file Teuchos_FancyOStream_decl.hpp.

Member Function Documentation

◆ operator=()

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 672 of file Teuchos_FancyOStream_decl.hpp.

◆ incrTab()

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 680 of file Teuchos_FancyOStream_decl.hpp.

◆ o()

template<typename CharT , typename Traits = std::char_traits<CharT>>
basic_FancyOStream< CharT, Traits > & Teuchos::basic_OSTab< CharT, Traits >::o ( ) const
inline

Definition at line 690 of file Teuchos_FancyOStream_decl.hpp.

◆ get()

template<typename CharT , typename Traits = std::char_traits<CharT>>
basic_FancyOStream< CharT, Traits > * Teuchos::basic_OSTab< CharT, Traits >::get ( ) const
inline

Definition at line 695 of file Teuchos_FancyOStream_decl.hpp.

Member Data Documentation

◆ DISABLE_TABBING

template<typename CharT , typename Traits = std::char_traits<CharT>>
const int Teuchos::basic_OSTab< CharT, Traits >::DISABLE_TABBING = -99999
static

Definition at line 604 of file Teuchos_FancyOStream_decl.hpp.


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