PyTrilinos::Teuchos::Time Class Reference

Inheritance diagram for PyTrilinos::Teuchos::Time:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::Teuchos::Time:

Collaboration graph
[legend]

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

Member Function Documentation

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

__init__(self, string name, bool start = False) -> Time

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

Construct with a descriptive name. 

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

__init__(self, string name, bool start = False) -> Time

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

Construct with a descriptive name. 

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

incrementNumCalls(self)

void
Teuchos::Time::incrementNumCalls()

Increment the number of times this timer has been called. 

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

incrementNumCalls(self)

void
Teuchos::Time::incrementNumCalls()

Increment the number of times this timer has been called. 

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

isRunning(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::isRunning (   self,
  args 
)

isRunning(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(self) -> string

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

Return the name of this timer. 

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

name(self) -> string

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

Return the name of this timer. 

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

numCalls(self) -> int

int
Teuchos::Time::numCalls() const

Return the number of times this timer has been called. 

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

numCalls(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(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::reset (   self,
  args 
)

reset(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(self, bool reset = False)

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

Starts the timer. 

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

start(self, bool reset = False)

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

Starts the timer. 

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

stop(self) -> double

double
Teuchos::Time::stop()

Stops the timer. 

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

stop(self) -> double

double
Teuchos::Time::stop()

Stops the timer. 

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

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

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

Returns the total time accumulated by this timer. This should be
called only when the clock is stopped.. 

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

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

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

Returns the total time accumulated by this timer. This should be
called only when the clock is stopped.. 

def PyTrilinos::Teuchos::Time::wallTime (   args  ) 

wallTime() -> double

def PyTrilinos::Teuchos::Time::wallTime (   args  ) 

wallTime() -> double


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

Generated on Thu Dec 17 11:00:23 2009 for PyTrilinos by  doxygen 1.5.9