vtkLogRecorder Class Reference

Record log messages at or below a given verbosity on a particular ParaView process/rank. More...

#include <vtkLogRecorder.h>

Inheritance diagram for vtkLogRecorder:

Collaboration diagram for vtkLogRecorder:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
	vtkLogRecorder ()
	The callback function that listens for log message will not be added until logging is enabled. More...
	~vtkLogRecorder () override
const std::string &	GetLogs () const
	Get the recorded logs. More...
const std::string &	GetStartingLog () const
	Get the starting log. More...
virtual int	GetMyRank ()
	Get the rank the log recorder is on. More...
void	ClearLogs ()
	Clear any logs recorded. More...
void	SetCategoryVerbosity (int categoryIndex, int verbosity)
	Set the verbosity of a ParaView logging category. More...
void	ResetCategoryVerbosities ()
	Clear custom verbosities set on all ParaView logging categories. More...
void	SetVerbosity (int verbosity)
	Set/get the verbosity of the entries recorded from the log. More...
virtual int	GetVerbosity ()
	Set/get the verbosity of the entries recorded from the log. More...
void	SetRankEnabled (int rank)
	Set to enable or disable logging, only if the rank parameter is equal to the rank that this log recorder is on. More...
void	SetRankDisabled (int rank)
	Set to enable or disable logging, only if the rank parameter is equal to the rank that this log recorder is on. More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual vtkMTimeType	GetMTime ()
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkLogRecorder *	New ()
static int	IsTypeOf (const char *type)
static vtkLogRecorder *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
static vtkObjectBase *	New ()
static vtkObjectBase *	New ()

Additional Inherited Members
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Record log messages at or below a given verbosity on a particular ParaView process/rank.

This class can be used to record log messages at or below a verbosity specified by SetVerbosity(). If the process is run as an MPI job, the log messages from a rank enabled via SetRankEnabled() will be recorded.

Definition at line 21 of file vtkLogRecorder.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkLogRecorder::Superclass

Definition at line 26 of file vtkLogRecorder.h.

Constructor & Destructor Documentation

vtkLogRecorder()

vtkLogRecorder::vtkLogRecorder

(

)

The callback function that listens for log message will not be added until logging is enabled.

The vtkLogRecorder object will query the multiprocess controller for its rank.

~vtkLogRecorder()

vtkLogRecorder::~vtkLogRecorder ( )

override

Member Function Documentation

New()

static vtkLogRecorder* vtkLogRecorder::New ( )

static

GetClassName()

virtual const char* vtkLogRecorder::GetClassName ( )

virtual

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkObjectBase.

SafeDownCast()

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

static

PrintSelf()

void vtkLogRecorder::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Reimplemented from vtkObject.

SetVerbosity()

void vtkLogRecorder::SetVerbosity

(

int

verbosity

)

Set/get the verbosity of the entries recorded from the log.

Any messages with verbosity less than or equal to this verbosity will be recorded.

GetVerbosity()

virtual int vtkLogRecorder::GetVerbosity ( )

virtual

Set/get the verbosity of the entries recorded from the log.

Any messages with verbosity less than or equal to this verbosity will be recorded.

SetRankEnabled()

void vtkLogRecorder::SetRankEnabled

(

int

rank

)

Set to enable or disable logging, only if the rank parameter is equal to the rank that this log recorder is on.

SetRankDisabled()

void vtkLogRecorder::SetRankDisabled

(

int

rank

)

Set to enable or disable logging, only if the rank parameter is equal to the rank that this log recorder is on.

GetLogs()

const std::string& vtkLogRecorder::GetLogs

(

)

const

Get the recorded logs.

GetStartingLog()

const std::string& vtkLogRecorder::GetStartingLog ( ) const

inline

Get the starting log.

Definition at line 63 of file vtkLogRecorder.h.

GetMyRank()

virtual int vtkLogRecorder::GetMyRank ( )

virtual

Get the rank the log recorder is on.

ClearLogs()

void vtkLogRecorder::ClearLogs

(

)

Clear any logs recorded.

SetCategoryVerbosity()

void vtkLogRecorder::SetCategoryVerbosity	(	int	categoryIndex,
		int	verbosity
	)

Set the verbosity of a ParaView logging category.

ResetCategoryVerbosities()

void vtkLogRecorder::ResetCategoryVerbosities

(

)

Clear custom verbosities set on all ParaView logging categories.

---

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

• /builds/gitlab-kitware-sciviz-ci/VTKExtensions/Core/vtkLogRecorder.h