#include <Teuchos_FancyOStream.hpp>
Public Types | |
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 Member Functions | |
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 () |
| |
Related Functions | |
(Note that these are not member functions.) | |
template<typename CharT , typename Traits > | |
RCP< basic_FancyOStream< CharT, Traits > > | fancyOStream (const RCP< std::basic_ostream< CharT, Traits > > &oStream, const std::basic_string< CharT, Traits > &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. | |
template<typename CharT , typename Traits > | |
RCP< basic_FancyOStream< CharT, Traits > > | getFancyOStream (const RCP< std::basic_ostream< CharT, Traits > > &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!. |
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:
setShowProcRank()
. showLinePrefix()
and OSTab::OSTab()
. setShowTabCount()
.
See FancyOutputting_test.cpp
for examples of how this class is used and the output it generates.
Definition at line 319 of file Teuchos_FancyOStream.hpp.
typedef CharT Teuchos::basic_FancyOStream< CharT, Traits >::char_type |
typedef traits_type::int_type Teuchos::basic_FancyOStream< CharT, Traits >::int_type |
typedef traits_type::off_type Teuchos::basic_FancyOStream< CharT, Traits >::off_type |
typedef std::basic_ostream<char_type, traits_type> Teuchos::basic_FancyOStream< CharT, Traits >::ostream_t |
typedef traits_type::pos_type Teuchos::basic_FancyOStream< CharT, Traits >::pos_type |
typedef basic_FancyOStream_buf<CharT,Traits> Teuchos::basic_FancyOStream< CharT, Traits >::streambuf_t |
Definition at line 339 of file Teuchos_FancyOStream.hpp.
typedef Traits Teuchos::basic_FancyOStream< CharT, Traits >::traits_type |
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 | |||
) | [inline, explicit] |
void Teuchos::basic_FancyOStream< CharT, Traits >::copyAllOutputOptions | ( | const basic_FancyOStream< CharT, Traits > & | oStream | ) | [inline] |
int Teuchos::basic_FancyOStream< CharT, Traits >::getNumCurrTabs | ( | ) | const [inline] |
RCP< std::basic_ostream< CharT, Traits > > Teuchos::basic_FancyOStream< CharT, Traits >::getOStream | ( | ) | [inline] |
int Teuchos::basic_FancyOStream< CharT, Traits >::getOutputToRootOnly | ( | ) | const [inline] |
const std::basic_string< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::getTabIndentStr | ( | ) | const [inline] |
const std::basic_string< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::getTopLinePrefix | ( | ) | const [inline] |
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 | |||
) | [inline] |
void Teuchos::basic_FancyOStream< CharT, Traits >::popDisableTabbing | ( | ) | [inline] |
void Teuchos::basic_FancyOStream< CharT, Traits >::popLinePrefix | ( | ) | [inline] |
void Teuchos::basic_FancyOStream< CharT, Traits >::popTab | ( | ) | [inline] |
void Teuchos::basic_FancyOStream< CharT, Traits >::pushDisableTabbing | ( | ) | [inline] |
void Teuchos::basic_FancyOStream< CharT, Traits >::pushLinePrefix | ( | const std::basic_string< char_type, traits_type > & | linePrefix | ) | [inline] |
void Teuchos::basic_FancyOStream< CharT, Traits >::pushTab | ( | const int | tabs = 1 |
) | [inline] |
basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setMaxLenLinePrefix | ( | const int | maxLenLinePrefix | ) | [inline] |
basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setOutputToRootOnly | ( | const int | rootRank | ) | [inline] |
basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setProcRankAndSize | ( | const int | procRank, | |
const int | numProcs | |||
) | [inline] |
basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setShowAllFrontMatter | ( | const bool | showAllFrontMatter | ) | [inline] |
Set if processor rank, line prefixes, and tab counts are shown or not .
Definition at line 1127 of file Teuchos_FancyOStream.hpp.
basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setShowLinePrefix | ( | const bool | showLinePrefix | ) | [inline] |
basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setShowProcRank | ( | const bool | showProcRank | ) | [inline] |
basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setShowTabCount | ( | const bool | showTabCount | ) | [inline] |
basic_FancyOStream< CharT, Traits > & Teuchos::basic_FancyOStream< CharT, Traits >::setTabIndentStr | ( | const std::basic_string< char_type, traits_type > & | tabIndentStr | ) | [inline] |
RCP< basic_FancyOStream< CharT, Traits > > fancyOStream | ( | const RCP< std::basic_ostream< CharT, Traits > > & | oStream, | |
const std::basic_string< CharT, Traits > & | 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.
Definition at line 457 of file Teuchos_FancyOStream.hpp.
RCP< basic_FancyOStream< CharT, Traits > > getFancyOStream | ( | const RCP< std::basic_ostream< CharT, Traits > > & | 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 485 of file Teuchos_FancyOStream.hpp.
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 683 of file Teuchos_FancyOStream.hpp.
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 645 of file Teuchos_FancyOStream.hpp.