Provides distributed log functionality. More...

#include <vtkParallelTimer.h>

Inheritance diagram for vtkParallelTimer:

Collaboration diagram for vtkParallelTimer:

Classes
class	LogBodyType
	Type used to direct an output stream into the log's body. More...

class	LogHeaderType
	Type used to direct an output stream into the log's header. More...

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkParallelTimer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	SetFileName (VTK_FILEPATH const std::string &fileName)

template<typename T >
vtkParallelTimer &	operator<< (const T &s)
	Insert text into the log header on the writer rank. More...

vtkParallelTimer::LogHeaderType	GetHeader ()
	stream output to the log's header(root rank only). More...

vtkParallelTimer::LogBodyType	GetBody ()
	stream output to log body(all ranks). More...

void	Clear ()
	Clear the log. More...

void	Update ()
	When an object is finished writing data to the log object it must call Update to send the data to the writer rank. More...

int	Write ()
	Write the log contents to a file. More...


virtual void	SetWriterRank (int)
	Set the rank who writes. More...

virtual int	GetWriterRank ()
	Set the rank who writes. More...


	vtkSetFilePathMacro (FileName)
	Set the filename that is used during write when the object is used as a singleton. More...

	vtkGetFilePathMacro (FileName)
	Set the filename that is used during write when the object is used as a singleton. More...


void	StartEvent (const char *event)
	The log works as an event stack. More...

void	StartEvent (int rank, const char *event)
	The log works as an event stack. More...

void	EndEvent (const char *event)
	The log works as an event stack. More...

void	EndEvent (int rank, const char *event)
	The log works as an event stack. More...

void	EndEventSynch (const char *event)
	The log works as an event stack. More...

void	EndEventSynch (int rank, const char *event)
	The log works as an event stack. More...


virtual void	SetWriteOnClose (int)
	If enabled and used as a singleton the log will write it's contents to disk during program termination. More...

virtual int	GetWriteOnClose ()
	If enabled and used as a singleton the log will write it's contents to disk during program termination. More...


virtual void	SetGlobalLevel (int)
	Set/Get the global log level. More...

virtual int	GetGlobalLevel ()
	Set/Get the global log level. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkParallelTimer *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkParallelTimer *	SafeDownCast (vtkObjectBase *o)

static vtkParallelTimer *	GetGlobalInstance ()
	The log class implements the singleton pattern so that it may be shared across class boundaries. More...

static void	DeleteGlobalInstance ()
	Explicitly delete the singleton. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkParallelTimer ()

virtual	~vtkParallelTimer ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Friends
class	LogHeaderType

class	LogBodyType

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Provides distributed log functionality.

When the file is written each process data is collected by rank 0 who writes the data to a single file in rank order.

The log works as an event stack. EventStart pushes the event identifier and its start time onto the stack. EventEnd pops the most recent event time and identifier computes the elapsed time and adds an entry to the log recording the event, it's start and end times, and its elapsed time. EndEventSynch includes a barrier before the measurement.

The log class implements the singleton pattern so that it may be shared across class boundaries. If the log instance doesn't exist then one is created. It will be automatically destroyed at exit by the signleton destructor. It can be destroyed explicitly by calling DeleteGlobalInstance.

Definition at line 55 of file vtkParallelTimer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkParallelTimer::Superclass

Definition at line 59 of file vtkParallelTimer.h.

Constructor & Destructor Documentation

◆ vtkParallelTimer()

vtkParallelTimer::vtkParallelTimer ( )

protected

◆ ~vtkParallelTimer()

virtual vtkParallelTimer::~vtkParallelTimer ( )

protectedvirtual

Member Function Documentation

◆ New()

static vtkParallelTimer * vtkParallelTimer::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkParallelTimer::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkParallelTimer::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkParallelTimer * vtkParallelTimer::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkParallelTimer::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkParallelTimer * vtkParallelTimer::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ SetWriterRank()

virtual void vtkParallelTimer::SetWriterRank ( int )

virtual

Set the rank who writes.

◆ GetWriterRank()

virtual int vtkParallelTimer::GetWriterRank ( )

virtual

Set the rank who writes.

◆ vtkSetFilePathMacro()

vtkParallelTimer::vtkSetFilePathMacro ( FileName )

Set the filename that is used during write when the object is used as a singleton.

If nothing is set the default is ROOT_RANKS_PID.log

◆ vtkGetFilePathMacro()

vtkParallelTimer::vtkGetFilePathMacro ( FileName )

Set the filename that is used during write when the object is used as a singleton.

If nothing is set the default is ROOT_RANKS_PID.log

◆ SetFileName()

void vtkParallelTimer::SetFileName ( VTK_FILEPATH const std::string & fileName )

inline

Definition at line 106 of file vtkParallelTimer.h.