#include <Teuchos_VerboseObject.hpp>
Public Member Functions | |
Constructors/Initializers | |
virtual | ~VerboseObjectBase () |
| |
VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) | |
Calls initializeVerboseObject() . | |
virtual void | initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) |
Calls initializeVerboseObject() . | |
virtual const VerboseObjectBase & | setOStream (const RCP< FancyOStream > &oStream) const |
The output stream for *this object. | |
virtual const VerboseObjectBase & | setOverridingOStream (const RCP< FancyOStream > &oStream) const |
Set the overriding the output stream for *this object. | |
virtual VerboseObjectBase & | setLinePrefix (const std::string &linePrefix) |
Set line prefix name for this object. | |
Query functions | |
virtual RCP< FancyOStream > | getOStream () const |
Return the output stream to be used for out for *this object. | |
virtual RCP< FancyOStream > | getOverridingOStream () const |
Return the the overriding output stream if set. | |
virtual std::string | getLinePrefix () const |
Get the line prefix for this object. | |
Utilities | |
virtual OSTab | getOSTab (const int tabs=1, const std::string &linePrefix="") const |
Create a tab object which sets the number of tabs and optionally the line prefix. | |
Static Public Member Functions | |
Public static member functions | |
static void | setDefaultOStream (const RCP< FancyOStream > &defaultOStream) |
Set the default output stream object. | |
static RCP< FancyOStream > | getDefaultOStream () |
Get the default output stream object. | |
Protected Member Functions | |
virtual void | informUpdatedVerbosityState () const |
Function that is called whenever the verbosity state is updated. |
Objects that derive from this interface print to a default class-owned (i.e. static) output stream object (set using setDefaultOStream()
) or the output stream can be set on an object-by-object basis using setOStream()
.
The output stream type is FancyOStream
which allows for automated indentation (using the OSTab
class) and has other useful features.
Definition at line 53 of file Teuchos_VerboseObject.hpp.
virtual Teuchos::VerboseObjectBase::~VerboseObjectBase | ( | ) | [inline, virtual] |
Teuchos::VerboseObjectBase::VerboseObjectBase | ( | const RCP< FancyOStream > & | oStream = Teuchos::null |
) | [explicit] |
RCP< FancyOStream > Teuchos::VerboseObjectBase::getDefaultOStream | ( | ) | [static] |
Get the default output stream object.
Definition at line 64 of file Teuchos_VerboseObject.cpp.
std::string Teuchos::VerboseObjectBase::getLinePrefix | ( | ) | const [virtual] |
OSTab Teuchos::VerboseObjectBase::getOSTab | ( | const int | tabs = 1 , |
|
const std::string & | linePrefix = "" | |||
) | const [virtual] |
Create a tab object which sets the number of tabs and optionally the line prefix.
tabs | [in] The number of relative tabs to add (if tabs > 0 ) or remove (if tabs < 0 ). If tabs == OSTab::DISABLE_TABBING then tabbing will be turned off temporarily. | |
linePrefix | [in] Sets a line prefix that overrides this->getLinePrefix() . |
OSTab
object is destroyed at the end of the block of code.
Returns OSTab( this->getOStream(), tabs, linePrefix.length() ? linePrefix : this->getLinePrefix() )
Definition at line 150 of file Teuchos_VerboseObject.cpp.
RCP< FancyOStream > Teuchos::VerboseObjectBase::getOStream | ( | ) | const [virtual] |
Return the output stream to be used for out for *this
object.
Definition at line 124 of file Teuchos_VerboseObject.cpp.
RCP< FancyOStream > Teuchos::VerboseObjectBase::getOverridingOStream | ( | ) | const [virtual] |
Return the the overriding output stream if set.
This is the output stream tthat will be returned from getOStream()
regardless that stream is set by setOStream()
.
Definition at line 135 of file Teuchos_VerboseObject.cpp.
void Teuchos::VerboseObjectBase::informUpdatedVerbosityState | ( | ) | const [protected, virtual] |
Function that is called whenever the verbosity state is updated.
Subclasses can override this function to be informed whenever the verbosity state of *this
object gets updated.
The default implementation simply does nothing.
Definition at line 164 of file Teuchos_VerboseObject.cpp.
void Teuchos::VerboseObjectBase::initializeVerboseObjectBase | ( | const RCP< FancyOStream > & | oStream = Teuchos::null |
) | [virtual] |
void Teuchos::VerboseObjectBase::setDefaultOStream | ( | const RCP< FancyOStream > & | defaultOStream | ) | [static] |
Set the default output stream object.
If this function is not called, then a default stream based on std::cout
is used.
Definition at line 55 of file Teuchos_VerboseObject.cpp.
VerboseObjectBase & Teuchos::VerboseObjectBase::setLinePrefix | ( | const std::string & | linePrefix | ) | [virtual] |
const VerboseObjectBase & Teuchos::VerboseObjectBase::setOStream | ( | const RCP< FancyOStream > & | oStream | ) | const [virtual] |
The output stream for *this
object.
This function is supposed by called by general clients to set the output stream according to some general logic in the code.
Definition at line 92 of file Teuchos_VerboseObject.cpp.
const VerboseObjectBase & Teuchos::VerboseObjectBase::setOverridingOStream | ( | const RCP< FancyOStream > & | oStream | ) | const [virtual] |
Set the overriding the output stream for *this
object.
This function is supposed to be called by special clients that want to set the output stream in a way that will not be overridden by setOStream()
.
Definition at line 101 of file Teuchos_VerboseObject.cpp.