Support Software for Vector Reduction/Transformation Operators Version of the Day
RTOpPack::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 <RTOpPack_SPMD_apply_op_def.hpp>

Inheritance diagram for RTOpPack::Teuchos::VerboseObject< ObjectType >:
Inheritance graph
[legend]

List of all members.

Public static member functions

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

Constructors/Initializers

 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 Calls initializeVerboseObject().
virtual void initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 Calls initializeVerboseObject().
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 Set the verbosity level for *this object.
virtual const VerboseObjectsetOverridingVerbLevel (const EVerbosityLevel verbLevel) const
 Set the overriding verbosity level for *this object.

Query functions

virtual EVerbosityLevel getVerbLevel () const
 Get the verbosity level.

Detailed Description

template<class ObjectType>
class RTOpPack::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 declared 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 219 of file RTOpPack_SPMD_apply_op_def.hpp.


Constructor & Destructor Documentation

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

Calls initializeVerboseObject().

Definition at line 362 of file RTOpPack_SPMD_apply_op_def.hpp.


Member Function Documentation

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

Set the default verbosity level.

If not called, then the default verbosity level is VERB_DEFAULT

Definition at line 345 of file RTOpPack_SPMD_apply_op_def.hpp.

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

Get the default verbosity level.

Definition at line 352 of file RTOpPack_SPMD_apply_op_def.hpp.

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

Calls initializeVerboseObject().

Definition at line 373 of file RTOpPack_SPMD_apply_op_def.hpp.

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

Set the verbosity level for *this object.

This function is supposed by called by general clients to set the output level according to some general logic in the code.

Definition at line 385 of file RTOpPack_SPMD_apply_op_def.hpp.

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

Set the overriding verbosity level for *this object.

This function is supposed to be called by special clients that want to set the output level in a way that will not be overridden by setOStream().

Definition at line 395 of file RTOpPack_SPMD_apply_op_def.hpp.

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

Get the verbosity level.

Definition at line 409 of file RTOpPack_SPMD_apply_op_def.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends