Teuchos::TimeMonitor Class Reference

A timer class that starts when constructed and stops when the destructor is called. More...

#include <Teuchos_TimeMonitor.hpp>

Collaboration diagram for Teuchos::TimeMonitor:

[legend]List of all members.

Public Member Functions
	TimeMonitor (Time &timer, bool reset=false)
	Constructor starts timer.
	~TimeMonitor ()
	Destructor causes timer to stop.
Static Public Member Functions
void	summarize (ostream &out=std::cout)
	Print summary statistics for a group of timers. Timings are gathered from all processors.
RefCountPtr< Time >	getNewTimer (const string &name)
	Create a new timer with the given name, and append it to the list of timers to be used.
Static Private Member Functions
void	gatherTimings (const Array< double > &timings, Array< double > &minTime, Array< double > &avgTime, Array< double > &maxTime)

---

Detailed Description

A timer class that starts when constructed and stops when the destructor is called.

Termination upon destruction lets this timer behave correctly even if scope is exited because of an exception.

Note:

Teuchos::TimeMonitor uses the Teuchos::Time class internally.

Examples:

TimeMonitor/cxx_main.cpp.

Definition at line 61 of file Teuchos_TimeMonitor.hpp.

---

Constructor & Destructor Documentation

Teuchos::TimeMonitor::TimeMonitor (  Time &  timer, bool  reset = false )  [inline]

Constructor starts timer. Definition at line 66 of file Teuchos_TimeMonitor.hpp.

Teuchos::TimeMonitor::~TimeMonitor (   )  [inline]

Destructor causes timer to stop. Definition at line 73 of file Teuchos_TimeMonitor.hpp.

---

Member Function Documentation

void TimeMonitor::summarize (  ostream &  out = std::cout  )  [static]

Print summary statistics for a group of timers. Timings are gathered from all processors. Note: This method must be called by all processors Examples: TimeMonitor/cxx_main.cpp. Definition at line 45 of file Teuchos_TimeMonitor.cpp.

RefCountPtr< Time > TimeMonitor::getNewTimer (  const string &  name  )  [static]

Create a new timer with the given name, and append it to the list of timers to be used. Examples: TimeMonitor/cxx_main.cpp. Definition at line 37 of file Teuchos_TimeMonitor.cpp.

void TimeMonitor::gatherTimings (  const Array< double > &  timings, Array< double > &  minTime, Array< double > &  avgTime, Array< double > &  maxTime )  [static, private]

collect summary timings from all processors Definition at line 91 of file Teuchos_TimeMonitor.cpp.

---

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

• Teuchos_TimeMonitor.hpp
• Teuchos_TimeMonitor.cpp

---