#include <vtkParallelTimer.h>

Inheritance diagram for vtkParallelTimer:

Collaboration diagram for vtkParallelTimer:

Classes
class	LogBodyType

class	LogHeaderType

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkParallelTimer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	Clear ()

void	Update ()

int	Write ()


virtual void	SetWriterRank (int)

virtual int	GetWriterRank ()


virtual void	SetFileName (const char *)

virtual char *	GetFileName ()

void	SetFileName (const std::string &fileName)


void	StartEvent (const char *event)

void	StartEvent (int rank, const char *event)

void	EndEvent (const char *event)

void	EndEvent (int rank, const char *event)

void	EndEventSynch (const char *event)

void	EndEventSynch (int rank, const char *event)


template<typename T >
vtkParallelTimer &	operator<< (const T &s)


vtkParallelTimer::LogHeaderType	GetHeader ()


vtkParallelTimer::LogBodyType	GetBody ()


virtual void	SetWriteOnClose (int)

virtual int	GetWriteOnClose ()


virtual void	SetGlobalLevel (int)

virtual int	GetGlobalLevel ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

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 )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkParallelTimer *	New ()

static int	IsTypeOf (const char *type)

static vtkParallelTimer *	SafeDownCast (vtkObjectBase *o)

static vtkParallelTimer *	GetGlobalInstance ()

static void	DeleteGlobalInstance ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkParallelTimer ()

virtual	~vtkParallelTimer ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

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 &)

class	LogHeaderType

class	LogBodyType

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Provides ditributed 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 ellapsed time and adds an entry to the log recording the event, it's start and end times, and its ellapsed time. EndEventSynch includes a barrier before the measurement.

The log class implements the singleton patern so that it may be shared accross 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 56 of file vtkParallelTimer.h.

Member Typedef Documentation

typedef vtkObject vtkParallelTimer::Superclass

Definition at line 60 of file vtkParallelTimer.h.

Constructor & Destructor Documentation

vtkParallelTimer::vtkParallelTimer ( )

protected

virtual vtkParallelTimer::~vtkParallelTimer ( )

protectedvirtual

Member Function Documentation

static vtkParallelTimer* vtkParallelTimer::New ( )

static

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

static

virtual int 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 vtkObject.

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

static

virtual vtkObjectBase* vtkParallelTimer::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkParallelTimer* vtkParallelTimer::NewInstance ( ) const

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

virtual

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.

virtual void vtkParallelTimer::SetWriterRank ( int )

virtual

Set the rank who writes.

virtual int vtkParallelTimer::GetWriterRank ( )

virtual

Set the rank who writes.

virtual void vtkParallelTimer::SetFileName ( const char * )

virtual

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

virtual char* vtkParallelTimer::GetFileName ( )

virtual

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

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

inline

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

Definition at line 95 of file vtkParallelTimer.h.

void vtkParallelTimer::StartEvent ( const char * event )

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 ellapsed time and adds an entry to the log recording the event, it's start and end times, and its ellapsed time. EndEventSynch includes a barrier before the measurement.

void vtkParallelTimer::StartEvent	(	int	rank,
		const char *	event
	)

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 ellapsed time and adds an entry to the log recording the event, it's start and end times, and its ellapsed time. EndEventSynch includes a barrier before the measurement.

void vtkParallelTimer::EndEvent ( const char * event )

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 ellapsed time and adds an entry to the log recording the event, it's start and end times, and its ellapsed time. EndEventSynch includes a barrier before the measurement.

void vtkParallelTimer::EndEvent	(	int	rank,
		const char *	event
	)

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 ellapsed time and adds an entry to the log recording the event, it's start and end times, and its ellapsed time. EndEventSynch includes a barrier before the measurement.

void vtkParallelTimer::EndEventSynch ( const char * event )

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 ellapsed time and adds an entry to the log recording the event, it's start and end times, and its ellapsed time. EndEventSynch includes a barrier before the measurement.

void vtkParallelTimer::EndEventSynch	(	int	rank,
		const char *	event
	)

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 ellapsed time and adds an entry to the log recording the event, it's start and end times, and its ellapsed time. EndEventSynch includes a barrier before the measurement.

template<typename T >

vtkParallelTimer & vtkParallelTimer::operator<< ( const T & s )

Insert text into the log header on the writer rank.

Definition at line 223 of file vtkParallelTimer.h.

vtkParallelTimer::LogHeaderType vtkParallelTimer::GetHeader ( )

inline

stream output to the log's header(root rank only).

Definition at line 124 of file vtkParallelTimer.h.

vtkParallelTimer::LogBodyType vtkParallelTimer::GetBody ( )

inline

stream output to log body(all ranks).

Definition at line 130 of file vtkParallelTimer.h.

void vtkParallelTimer::Clear ( )

Clear the log.

void vtkParallelTimer::Update ( )

When an object is finished writing data to the log object it must call Update to send the data to the writer rank. This ensures that all data is transfered to the root before MPI_Finalize is called while allowing the write to occur after Mpi_finalize. Note: This is a collective call.

int vtkParallelTimer::Write ( )

Write the log contents to a file.

static vtkParallelTimer* vtkParallelTimer::GetGlobalInstance ( )

static

The log class implements the singleton patern so that it may be shared accross 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.

static void vtkParallelTimer::DeleteGlobalInstance ( )

static

Explicitly delete the singleton.

virtual void vtkParallelTimer::SetWriteOnClose ( int )

virtual

If enabled and used as a singleton the log will write it's contents to disk during program termination.

virtual int vtkParallelTimer::GetWriteOnClose ( )

virtual

If enabled and used as a singleton the log will write it's contents to disk during program termination.

virtual void vtkParallelTimer::SetGlobalLevel ( int )

virtual

Set/Get the global log level. Applications can set this to the desired level so that all pipeline objects will log data.

virtual int vtkParallelTimer::GetGlobalLevel ( )

virtual

Set/Get the global log level. Applications can set this to the desired level so that all pipeline objects will log data.

Friends And Related Function Documentation

friend class LogHeaderType

friend

Definition at line 216 of file vtkParallelTimer.h.

friend class LogBodyType

friend

Definition at line 217 of file vtkParallelTimer.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/ParallelLIC/vtkParallelTimer.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation