VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkParallelTimer Class Reference

#include <vtkParallelTimer.h>

Inheritance diagram for vtkParallelTimer:
[legend]
Collaboration diagram for vtkParallelTimer:
[legend]

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...
 
vtkParallelTimerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetWriterRank (int)
 Set the rank who writes. More...
 
virtual int GetWriterRank ()
 
virtual void SetFileName (const char *)
 Set the filename that is used during write when the object is used as a singleton. More...
 
virtual char * GetFileName ()
 
void SetFileName (const std::string &fileName)
 
void StartEvent (const char *event)
 The log works as an event stack. More...
 
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 >
vtkParallelTimeroperator<< (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 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 ()
 
virtual void SetGlobalLevel (int)
 Set/Get the global log level. More...
 
virtual int GetGlobalLevel ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkParallelTimerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkParallelTimerSafeDownCast (vtkObjectBase *o)
 
static vtkParallelTimerGetGlobalInstance ()
 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 vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Friends

class LogHeaderType
 
class LogBodyType
 

Additional Inherited Members

- 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

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

◆ SetFileName() [1/2]

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

◆ GetFileName()

virtual char* vtkParallelTimer::GetFileName ( )
virtual

◆ SetFileName() [2/2]

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

Definition at line 106 of file vtkParallelTimer.h.

◆ StartEvent() [1/2]

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 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.

◆ StartEvent() [2/2]

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

◆ EndEvent() [1/2]

void vtkParallelTimer::EndEvent ( const char *  event)

◆ EndEvent() [2/2]

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

◆ EndEventSynch() [1/2]

void vtkParallelTimer::EndEventSynch ( const char *  event)

◆ EndEventSynch() [2/2]

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

◆ operator<<()

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

Insert text into the log header on the writer rank.

Definition at line 244 of file vtkParallelTimer.h.

◆ GetHeader()

vtkParallelTimer::LogHeaderType vtkParallelTimer::GetHeader ( )
inline

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

Definition at line 134 of file vtkParallelTimer.h.

◆ GetBody()

vtkParallelTimer::LogBodyType vtkParallelTimer::GetBody ( )
inline

stream output to log body(all ranks).

Definition at line 139 of file vtkParallelTimer.h.

◆ Clear()

void vtkParallelTimer::Clear ( )

Clear the log.

◆ Update()

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 transferred to the root before MPI_Finalize is called while allowing the write to occur after Mpi_finalize. Note: This is a collective call.

◆ Write()

int vtkParallelTimer::Write ( )

Write the log contents to a file.

◆ GetGlobalInstance()

static vtkParallelTimer* vtkParallelTimer::GetGlobalInstance ( )
static

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.

◆ DeleteGlobalInstance()

static void vtkParallelTimer::DeleteGlobalInstance ( )
static

Explicitly delete the singleton.

◆ SetWriteOnClose()

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.

◆ GetWriteOnClose()

virtual int vtkParallelTimer::GetWriteOnClose ( )
virtual

◆ SetGlobalLevel()

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.

◆ GetGlobalLevel()

virtual int vtkParallelTimer::GetGlobalLevel ( )
virtual

Friends And Related Function Documentation

◆ LogHeaderType

friend class LogHeaderType
friend

Definition at line 238 of file vtkParallelTimer.h.

◆ LogBodyType

friend class LogBodyType
friend

Definition at line 239 of file vtkParallelTimer.h.


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