PyTrilinos.Teuchos.Time Class Reference

Inheritance diagram for PyTrilinos.Teuchos.Time:

Collaboration diagram for PyTrilinos.Teuchos.Time:

List of all members.

Public Member Functions
def	__init__
def	wallTime
def	start
def	stop
def	totalElapsedTime
def	reset
def	isRunning
def	name
def	incrementNumCalls
def	numCalls
Public Attributes
	this

---

Detailed Description

Basic wall-clock timer class.

To time a section of code, place it in between calls to start() and
stop().

For std::exception safety and correct behavior in reentrant code, this
class should generally be used only through the Teuchos::TimeMonitor
mechanism.

C++ includes: Teuchos_Time.hpp 

---

Constructor & Destructor Documentation

def PyTrilinos.Teuchos.Time.__init__	(		self,
			args
	)

__init__(Teuchos::Time self, std::string const & name, bool start=False) -> Time

Teuchos::Time::Time(const
std::string &name, bool start=false)

Construct with a descriptive name. 

---

Member Function Documentation

def PyTrilinos.Teuchos.Time.incrementNumCalls	(		self,
			args
	)

incrementNumCalls(Time self)

void
Teuchos::Time::incrementNumCalls()

Increment the number of times this timer has been called. 

def PyTrilinos.Teuchos.Time.isRunning	(		self,
			args
	)

isRunning(Time self) -> bool

bool
Teuchos::Time::isRunning() const

Indicates if this timer is currently running, i.e., if it has been
started but not yet stopped.

It is necessary to know if a timer is running to avoid incorrectly
starting or stopping in reentrant code. 

def PyTrilinos.Teuchos.Time.name	(		self,
			args
	)

name(Time self) -> std::string const &

const std::string&
Teuchos::Time::name() const

Return the name of this timer. 

def PyTrilinos.Teuchos.Time.numCalls	(		self,
			args
	)

numCalls(Time self) -> int

int
Teuchos::Time::numCalls() const

Return the number of times this timer has been called. 

def PyTrilinos.Teuchos.Time.reset	(		self,
			args
	)

reset(Time self)

void
Teuchos::Time::reset()

Resets the cummulative time and number of times this timer has been
called. Does not affect any other state. 

def PyTrilinos.Teuchos.Time.start	(		self,
			args
	)

start(Time self, bool reset=False)

void
Teuchos::Time::start(bool reset=false)

Starts the timer. 

def PyTrilinos.Teuchos.Time.stop	(		self,
			args
	)

stop(Time self) -> double

double
Teuchos::Time::stop()

Stops the timer. 

def PyTrilinos.Teuchos.Time.totalElapsedTime	(		self,
			args
	)

totalElapsedTime(Time self, bool readCurrentTime=False) -> double

double
Teuchos::Time::totalElapsedTime(bool readCurrentTime=false) const

Returns the total time (in seconds) accumulated by this timer.

This should be called only when the clock is stopped. 

def PyTrilinos.Teuchos.Time.wallTime

(

args

)

wallTime() -> double

---

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

• Teuchos.py