Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkPVLogger Class Reference

defines various logging categories for ParaView More...

#include <vtkPVLogger.h>

Inherits vtkLogger.

Public Types

typedef vtkLogger Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPVLoggerSafeDownCast (vtkObject *o)
 
static Verbosity GetPipelineVerbosity ()
 Use this verbosity level when logging messages that provide information about pipeline update requests, etc. More...
 
static void SetPipelineVerbosity (Verbosity value)
 Use this verbosity level when logging messages that provide information about pipeline update requests, etc. More...
 
static Verbosity GetExecutionVerbosity ()
 Use this verbosity level when logging messages that provide information about algorithm execution. More...
 
static void SetExecutionVerbosity (Verbosity value)
 Use this verbosity level when logging messages that provide information about algorithm execution. More...
 
static Verbosity GetPluginVerbosity ()
 Use this verbosity level to for log message relating to ParaView's plugin system. More...
 
static void SetPluginVerbosity (Verbosity value)
 Use this verbosity level to for log message relating to ParaView's plugin system. More...
 
static Verbosity GetDataMovementVerbosity ()
 Verbosity level for log messages related to data-movement e.g. More...
 
static void SetDataMovementVerbosity (Verbosity value)
 Verbosity level for log messages related to data-movement e.g. More...
 
static Verbosity GetRenderingVerbosity ()
 Verbosity level for log messages related to rendering. More...
 
static void SetRenderingVerbosity (Verbosity value)
 Verbosity level for log messages related to rendering. More...
 
static Verbosity GetApplicationVerbosity ()
 Verbosity level for log messages related to the application, gui, and similar components. More...
 
static void SetApplicationVerbosity (Verbosity value)
 Verbosity level for log messages related to the application, gui, and similar components. More...
 
static Verbosity GetDefaultVerbosity ()
 Change default verbosity to use for all ParaView categories defined here if no overrides are specified. More...
 
static void SetDefaultVerbosity (Verbosity value)
 Change default verbosity to use for all ParaView categories defined here if no overrides are specified. More...
 

Protected Member Functions

 vtkPVLogger ()
 
 ~vtkPVLogger () override
 

Detailed Description

defines various logging categories for ParaView

ParaView code generates informative log entires under several categories. This class provides ability to convert a category to a verbosity level to use to log a message.

All code in ParaView that generates informative log messages should use one of the categories defined here when logging. For example, to log a message about rendering, one uses GetRenderingVerbosity or the convenience macro PARAVIEW_LOG_RENDERING_VERBOSITY() as follows:

vtkVLogF(PARAVIEW_LOG_RENDERING_VERBOSITY(), "message about rendering");

Developers can elevate verbosity level for any category using the APIs provided on vtkPVLogger e.g. SetRenderingVerbosity.

At runtime, users can elevate verbosity level for any category by setting the corresponding environment variable to level requested e.g. to make all rendering log message show up as INFO, and thus show up on the terminal by default, set the environment variable PARAVIEW_LOG_RENDERING_VERBOSITY to INFO or 0.

When not changed using the APIs or environment variables, all categories default to vtkLogger::VERBOSITY_TRACE. To change the default used, use vtkPVLogger::SetDefaultVerbosity.

Definition at line 52 of file vtkPVLogger.h.

Member Typedef Documentation

◆ Superclass

typedef vtkLogger vtkPVLogger::Superclass

Definition at line 55 of file vtkPVLogger.h.

Constructor & Destructor Documentation

◆ vtkPVLogger()

vtkPVLogger::vtkPVLogger ( )
protected

◆ ~vtkPVLogger()

vtkPVLogger::~vtkPVLogger ( )
overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPVLogger::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkPVLogger::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkPVLogger::IsA ( const char *  type)
virtual

◆ SafeDownCast()

static vtkPVLogger* vtkPVLogger::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

void vtkPVLogger::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ GetPipelineVerbosity()

static Verbosity vtkPVLogger::GetPipelineVerbosity ( )
static

Use this verbosity level when logging messages that provide information about pipeline update requests, etc.

Default level is vtkLogger::VERBOSITY_TRACE unless overridden by calling SetPipelineVerbosity or by setting the environment variable PARAVIEW_LOG_PIPELINE_VERBOSITY to the expected verbosity level.

◆ SetPipelineVerbosity()

static void vtkPVLogger::SetPipelineVerbosity ( Verbosity  value)
static

Use this verbosity level when logging messages that provide information about pipeline update requests, etc.

Default level is vtkLogger::VERBOSITY_TRACE unless overridden by calling SetPipelineVerbosity or by setting the environment variable PARAVIEW_LOG_PIPELINE_VERBOSITY to the expected verbosity level.

◆ GetExecutionVerbosity()

static Verbosity vtkPVLogger::GetExecutionVerbosity ( )
static

Use this verbosity level when logging messages that provide information about algorithm execution.

Default level is vtkLogger::VERBOSITY_TRACE unless overridden by calling SetPipelineVerbosity or by setting the environment variable PARAVIEW_LOG_EXECUTION_VERBOSITY to the expected verbosity level.

◆ SetExecutionVerbosity()

static void vtkPVLogger::SetExecutionVerbosity ( Verbosity  value)
static

Use this verbosity level when logging messages that provide information about algorithm execution.

Default level is vtkLogger::VERBOSITY_TRACE unless overridden by calling SetPipelineVerbosity or by setting the environment variable PARAVIEW_LOG_EXECUTION_VERBOSITY to the expected verbosity level.

◆ GetPluginVerbosity()

static Verbosity vtkPVLogger::GetPluginVerbosity ( )
static

Use this verbosity level to for log message relating to ParaView's plugin system.

Default level is vtkLogger::VERBOSITY_TRACE unless overridden by calling SetPluginVerbosity or by setting the environment variable PARAVIEW_LOG_PLUGIN_VERBOSITY to the expected verbosity level.

◆ SetPluginVerbosity()

static void vtkPVLogger::SetPluginVerbosity ( Verbosity  value)
static

Use this verbosity level to for log message relating to ParaView's plugin system.

Default level is vtkLogger::VERBOSITY_TRACE unless overridden by calling SetPluginVerbosity or by setting the environment variable PARAVIEW_LOG_PLUGIN_VERBOSITY to the expected verbosity level.

◆ GetDataMovementVerbosity()

static Verbosity vtkPVLogger::GetDataMovementVerbosity ( )
static

Verbosity level for log messages related to data-movement e.g.

moving data between processes for rendering.

Default level is vtkLogger::VERBOSITY_TRACE unless overridden by calling SetDataMovementVerbosity or by setting the environment variable PARAVIEW_LOG_DATA_MOVEMENT_VERBOSITY to the expected verbosity level.

◆ SetDataMovementVerbosity()

static void vtkPVLogger::SetDataMovementVerbosity ( Verbosity  value)
static

Verbosity level for log messages related to data-movement e.g.

moving data between processes for rendering.

Default level is vtkLogger::VERBOSITY_TRACE unless overridden by calling SetDataMovementVerbosity or by setting the environment variable PARAVIEW_LOG_DATA_MOVEMENT_VERBOSITY to the expected verbosity level.

◆ GetRenderingVerbosity()

static Verbosity vtkPVLogger::GetRenderingVerbosity ( )
static

Verbosity level for log messages related to rendering.

Default level is vtkLogger::VERBOSITY_TRACE unless overridden by calling SetRenderingVerbosity or by setting the environment variable PARAVIEW_LOG_RENDERING_VERBOSITY to the expected verbosity level.

◆ SetRenderingVerbosity()

static void vtkPVLogger::SetRenderingVerbosity ( Verbosity  value)
static

Verbosity level for log messages related to rendering.

Default level is vtkLogger::VERBOSITY_TRACE unless overridden by calling SetRenderingVerbosity or by setting the environment variable PARAVIEW_LOG_RENDERING_VERBOSITY to the expected verbosity level.

◆ GetApplicationVerbosity()

static Verbosity vtkPVLogger::GetApplicationVerbosity ( )
static

Verbosity level for log messages related to the application, gui, and similar components.

Default level is vtkLogger::VERBOSITY_TRACE unless overridden by calling SetRenderingVerbosity or by setting the environment variable PARAVIEW_LOG_APPLICATION_VERBOSITY to the expected verbosity level.

◆ SetApplicationVerbosity()

static void vtkPVLogger::SetApplicationVerbosity ( Verbosity  value)
static

Verbosity level for log messages related to the application, gui, and similar components.

Default level is vtkLogger::VERBOSITY_TRACE unless overridden by calling SetRenderingVerbosity or by setting the environment variable PARAVIEW_LOG_APPLICATION_VERBOSITY to the expected verbosity level.

◆ GetDefaultVerbosity()

static Verbosity vtkPVLogger::GetDefaultVerbosity ( )
static

Change default verbosity to use for all ParaView categories defined here if no overrides are specified.

This is intended to be used by ParaView-based applications to change the level at which ParaView messages are logged in bulk.

Default level is vtkLogger::VERBOSITY_TRACE.

◆ SetDefaultVerbosity()

static void vtkPVLogger::SetDefaultVerbosity ( Verbosity  value)
static

Change default verbosity to use for all ParaView categories defined here if no overrides are specified.

This is intended to be used by ParaView-based applications to change the level at which ParaView messages are logged in bulk.

Default level is vtkLogger::VERBOSITY_TRACE.


The documentation for this class was generated from the following file: