#include <Teuchos_VerboseObject.hpp>
Public Member Functions | |
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 VerboseObject & | setVerbLevel (const EVerbosityLevel verbLevel) const |
Set the verbosity level for *this object. | |
virtual const VerboseObject & | setOverridingVerbLevel (const EVerbosityLevel verbLevel) const |
Set the overriding verbosity level for *this object. | |
Query functions | |
virtual EVerbosityLevel | getVerbLevel () const |
Get the verbosity level. | |
Static Public Member Functions | |
Public static member functions | |
static void | setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel) |
Set the default verbosity level. | |
static EVerbosityLevel | getDefaultVerbLevel () |
Get the default verbosity level. | |
Related Functions | |
(Note that these are not member functions.) | |
RCP< const ParameterList > | getValidVerboseObjectSublist () |
Return the sublist of valid parameters for the "VerboseObject" sublist. | |
void | setupVerboseObjectSublist (ParameterList *paramList) |
Setup a sublist called "VerboseObject" in the given parameter list. | |
void | readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel) |
Read the parameters in the "VerboseObject" sublist and set them on the given VerboseObject. | |
template<class ObjectType > | |
void | readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject) |
Read the parameters in the "VerboseObject" sublist and set them on the given VerboseObject. |
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 197 of file Teuchos_VerboseObject.hpp.
Teuchos::VerboseObject< ObjectType >::VerboseObject | ( | const EVerbosityLevel | verbLevel = VERB_DEFAULT , |
|
const RCP< FancyOStream > & | oStream = Teuchos::null | |||
) | [inline, explicit] |
EVerbosityLevel Teuchos::VerboseObject< ObjectType >::getDefaultVerbLevel | ( | ) | [inline, static] |
EVerbosityLevel Teuchos::VerboseObject< ObjectType >::getVerbLevel | ( | ) | const [inline, virtual] |
void Teuchos::VerboseObject< ObjectType >::initializeVerboseObject | ( | const EVerbosityLevel | verbLevel = VERB_DEFAULT , |
|
const RCP< FancyOStream > & | oStream = Teuchos::null | |||
) | [inline, virtual] |
void Teuchos::VerboseObject< ObjectType >::setDefaultVerbLevel | ( | const EVerbosityLevel | defaultVerbLevel | ) | [inline, static] |
Set the default verbosity level.
If not called, then the default verbosity level is VERB_DEFAULT
Definition at line 323 of file Teuchos_VerboseObject.hpp.
const VerboseObject< ObjectType > & Teuchos::VerboseObject< ObjectType >::setOverridingVerbLevel | ( | const EVerbosityLevel | verbLevel | ) | const [inline, 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 373 of file Teuchos_VerboseObject.hpp.
const VerboseObject< ObjectType > & Teuchos::VerboseObject< ObjectType >::setVerbLevel | ( | const EVerbosityLevel | verbLevel | ) | const [inline, 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 363 of file Teuchos_VerboseObject.hpp.
RCP< const ParameterList > getValidVerboseObjectSublist | ( | ) | [related] |
Return the sublist of valid parameters for the "VerboseObject" sublist.
This function need not be directly called by clients since the function setupVerboseObjectSublist()
sets up the sublist automatically.
void readVerboseObjectSublist | ( | ParameterList * | paramList, | |
VerboseObject< ObjectType > * | verboseObject | |||
) | [related] |
Read the parameters in the "VerboseObject" sublist and set them on the given VerboseObject.
paramList | [in/out] On input, contains the user's parameter list for the given objet for which "VerboseObject" can be a sublist of. | |
verboseObject | [in/out] The verbose object that will have its verbosity level and/or output stream set. |
readVerboseObjectSublist()
to validate and and read the verbosity and output stream from the "VerboseObject" sublist.
void readVerboseObjectSublist | ( | ParameterList * | paramList, | |
RCP< FancyOStream > * | oStream, | |||
EVerbosityLevel * | verbLevel | |||
) | [related] |
Read the parameters in the "VerboseObject" sublist and set them on the given VerboseObject.
paramList | [in/out] On input, contains the user's parameter list for the given objet for which "VerboseObject" can be a sublist of. | |
oStream | [out] The oStream object to be used. On output, oStream->get()!=0 if an output stream was specified by the parameter sublist. | |
verbLevel | [out] The verbosity level to be used. On output, *verbLevel gives the verbosity level set in the parameter list. If no verbosity level was set, then a value of *verbLevel==VERB_DEFAULT will be set on return. |
oStream!=0
verbLevel!=0
void setupVerboseObjectSublist | ( | ParameterList * | paramList | ) | [related] |
Setup a sublist called "VerboseObject" in the given parameter list.
paramList | [in/out] The parameter list hat the "VerboseObject" sublist will be added to |
paramList!=0