Teuchos::basic_FancyOStream_buf< CharT, Traits > Class Template Reference
[Teuchos Outputting Utilities]

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

#include <Teuchos_FancyOStream.hpp>

List of all members.

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)
 
int getProcRank () const
 
int getNumProcs () const
 
void setOutputToRootOnly (const int rootRank)
 
int getOutputToRootOnly () const
 
void pushTab (const int tabs)
 
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 ()
 

Protected Member Functions

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 50 of file Teuchos_FancyOStream.hpp.


Member Typedef Documentation

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

Definition at line 55 of file Teuchos_FancyOStream.hpp.

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

Definition at line 57 of file Teuchos_FancyOStream.hpp.

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

Definition at line 59 of file Teuchos_FancyOStream.hpp.

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

Definition at line 61 of file Teuchos_FancyOStream.hpp.

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

Definition at line 63 of file Teuchos_FancyOStream.hpp.


Constructor & Destructor Documentation

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 736 of file Teuchos_FancyOStream.hpp.


Member Function Documentation

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 752 of file Teuchos_FancyOStream.hpp.

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

Definition at line 783 of file Teuchos_FancyOStream.hpp.

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 790 of file Teuchos_FancyOStream.hpp.

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

Definition at line 800 of file Teuchos_FancyOStream.hpp.

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

Definition at line 807 of file Teuchos_FancyOStream.hpp.

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

Definition at line 814 of file Teuchos_FancyOStream.hpp.

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

Definition at line 821 of file Teuchos_FancyOStream.hpp.

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

Definition at line 829 of file Teuchos_FancyOStream.hpp.

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

Definition at line 836 of file Teuchos_FancyOStream.hpp.

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

Definition at line 843 of file Teuchos_FancyOStream.hpp.

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

Definition at line 850 of file Teuchos_FancyOStream.hpp.

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

Definition at line 857 of file Teuchos_FancyOStream.hpp.

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

Definition at line 864 of file Teuchos_FancyOStream.hpp.

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

Definition at line 874 of file Teuchos_FancyOStream.hpp.

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

Definition at line 881 of file Teuchos_FancyOStream.hpp.

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

Definition at line 888 of file Teuchos_FancyOStream.hpp.

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

Definition at line 912 of file Teuchos_FancyOStream.hpp.

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

Definition at line 919 of file Teuchos_FancyOStream.hpp.

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

Definition at line 933 of file Teuchos_FancyOStream.hpp.

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

Definition at line 940 of file Teuchos_FancyOStream.hpp.

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

Definition at line 948 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits>
void Teuchos::basic_FancyOStream_buf< CharT, Traits >::popLinePrefix (  ) 

Definition at line 957 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits>
const std::basic_string< CharT, Traits > & Teuchos::basic_FancyOStream_buf< CharT, Traits >::getTopLinePrefix (  )  const

Definition at line 965 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits>
void Teuchos::basic_FancyOStream_buf< CharT, Traits >::pushDisableTabbing (  ) 

Definition at line 972 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits>
void Teuchos::basic_FancyOStream_buf< CharT, Traits >::popDisableTabbing (  ) 

Definition at line 979 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits>
std::streamsize Teuchos::basic_FancyOStream_buf< CharT, Traits >::xsputn ( const char_type s,
std::streamsize  n 
) [protected]

Definition at line 989 of file Teuchos_FancyOStream.hpp.

template<typename CharT, typename Traits>
basic_FancyOStream_buf< CharT, Traits >::int_type Teuchos::basic_FancyOStream_buf< CharT, Traits >::overflow ( int_type  c  )  [protected]

Definition at line 1003 of file Teuchos_FancyOStream.hpp.


The documentation for this class was generated from the following file:
Generated on Tue Jul 13 09:23:01 2010 for Teuchos - Trilinos Tools Package by  doxygen 1.4.7