Teuchos::VerboseObject< ObjectType > Class Template Reference

Templated base class for objects that can print their activities to a stream and have a verbosity level. More...

#include <Teuchos_VerboseObject.hpp>

Inheritance diagram for Teuchos::VerboseObject< ObjectType >:

Teuchos::VerboseObjectBase List of all members.

Public Member Functions

Constructors/Initializers
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RefCountPtr< FancyOStream > &oStream=Teuchos::null)
 Calls initializeVerboseObject().
virtual void initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RefCountPtr< FancyOStream > &oStream=Teuchos::null)
 Calls initializeVerboseObject().
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 Override the verbosity level for *this object.
Query functions
virtual EVerbosityLevel getVerbLevel () const
 Get the verbosity level.

Static Public Member Functions

Public static member functions
void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 Set the default verbosity level.
EVerbosityLevel getDefaultVerbLevel ()
 Get the default verbosity level.

Detailed Description

template<class ObjectType>
class Teuchos::VerboseObject< ObjectType >

Templated base class for objects that can print their activities to a stream and have a verbosity level.

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() . In addition, each object, by default, has a verbosity level that is shared by all objects (set using setDefaultVerbosityLevel()) or can be set on an object-by-object basis using setVerbLevel().

The output stream type is FancyOStream which allows for automated indentation (using the OSTab class) and has other useful features.

Note that setOStream() and setVerbLevel() are actually decalared as const functions. This is to allow a client to temporarily change the stream and verbosity level. To do this saftely, use the class VerboseObjectTempState which will revert the output state after it is destroyed.

Definition at line 160 of file Teuchos_VerboseObject.hpp.


Constructor & Destructor Documentation

template<class ObjectType>
Teuchos::VerboseObject< ObjectType >::VerboseObject const EVerbosityLevel  verbLevel = VERB_DEFAULT,
const RefCountPtr< FancyOStream > &  oStream = Teuchos::null
[explicit]
 

Calls initializeVerboseObject().

Definition at line 280 of file Teuchos_VerboseObject.hpp.


Member Function Documentation

template<class ObjectType>
void Teuchos::VerboseObject< ObjectType >::setDefaultVerbLevel const EVerbosityLevel  defaultVerbLevel  )  [static]
 

Set the default verbosity level.

If not called, then the default verbosity level is VERB_DEFAULT

Examples:
FancyOutputting_test.cpp.

Definition at line 266 of file Teuchos_VerboseObject.hpp.

template<class ObjectType>
EVerbosityLevel Teuchos::VerboseObject< ObjectType >::getDefaultVerbLevel  )  [static]
 

Get the default verbosity level.

Examples:
FancyOutputting_test.cpp.

Definition at line 272 of file Teuchos_VerboseObject.hpp.

template<class ObjectType>
void Teuchos::VerboseObject< ObjectType >::initializeVerboseObject const EVerbosityLevel  verbLevel = VERB_DEFAULT,
const RefCountPtr< FancyOStream > &  oStream = Teuchos::null
[virtual]
 

Calls initializeVerboseObject().

Definition at line 289 of file Teuchos_VerboseObject.hpp.

template<class ObjectType>
const VerboseObject< ObjectType > & Teuchos::VerboseObject< ObjectType >::setVerbLevel const EVerbosityLevel  verbLevel  )  const [virtual]
 

Override the verbosity level for *this object.

Definition at line 300 of file Teuchos_VerboseObject.hpp.

template<class ObjectType>
EVerbosityLevel Teuchos::VerboseObject< ObjectType >::getVerbLevel  )  const [virtual]
 

Get the verbosity level.

Definition at line 309 of file Teuchos_VerboseObject.hpp.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:30:33 2008 for Teuchos - Trilinos Tools Package by doxygen 1.3.9.1