otb::Stopwatch Class Reference

#include <otbStopwatch.h>

Public Types
typedef uint64_t	DurationType
typedef Stopwatch	Self

Public Member Functions
std::string	GetElapsedHumanReadableTime () const
void	GetElapsedHumanReadableTime (std::ostream &oss) const
DurationType	GetElapsedMilliseconds () const
bool	IsRunning () const
void	Reset ()
void	Restart ()
void	Start ()
void	Stop ()
	Stopwatch ()

Static Public Member Functions
static Stopwatch	StartNew ()

Private Types
typedef uint64_t	TimepointType

Private Member Functions
DurationType	GetRunningElapsedTime () const
TimepointType	GetTimestamp () const

Private Attributes
DurationType	m_ElapsedMilliseconds
bool	m_IsRunning
TimepointType	m_StartTime

Detailed Description

Stopwatch timer.

A simple class for measuring elapsed time.

Definition at line 41 of file otbStopwatch.h.

Member Typedef Documentation

DurationType

typedef uint64_t otb::Stopwatch::DurationType

Represents a duration measured in milliseconds

Definition at line 48 of file otbStopwatch.h.

Self

typedef Stopwatch otb::Stopwatch::Self

Standard class typedefs.

Definition at line 45 of file otbStopwatch.h.

TimepointType

typedef uint64_t otb::Stopwatch::TimepointType

private

Definition at line 82 of file otbStopwatch.h.

Constructor & Destructor Documentation

Stopwatch()

otb::Stopwatch::Stopwatch

(

)

Constructs a timer instance

Member Function Documentation

GetElapsedHumanReadableTime() [1/2]

std::string otb::Stopwatch::GetElapsedHumanReadableTime

(

)

const

Get the total duration in human readable format

GetElapsedHumanReadableTime() [2/2]

void otb::Stopwatch::GetElapsedHumanReadableTime

(

std::ostream &

oss

)

const

Get the total duration in human readable format (ostream version)

GetElapsedMilliseconds()

DurationType otb::Stopwatch::GetElapsedMilliseconds

(

)

const

Get the total duration, excluding the current iteration

Referenced by otb::PersistentSamplingFilterBase< TInputImage >::GatherOutputVectors(), otb::PersistentImageToOGRLayerFilter< TImageType >::GenerateData(), otb::VectorDataTransformFilter< TInputVectorData, TOutputVectorData >::GenerateData(), otb::VectorDataToVectorDataFilter< TVectorData, TVectorData >::GenerateData(), otb::VectorDataExtractROI< TVectorData >::GenerateData(), otb::PersistentImageToOGRDataFilter< TImage >::GenerateData(), otb::VectorDataProjectionFilter< TInputVectorData, TOutputVectorData >::GenerateData(), and otb::PersistentImageToOGRLayerSegmentationFilter< TImageType, TSegmentationFilter >::ProcessTile().

GetRunningElapsedTime()

DurationType otb::Stopwatch::GetRunningElapsedTime ( ) const

private

GetTimestamp()

TimepointType otb::Stopwatch::GetTimestamp ( ) const

private

IsRunning()

bool otb::Stopwatch::IsRunning

(

)

const

Returns whether the stopwatch is running

Reset()

void otb::Stopwatch::Reset

(

)

Reset the timer

Restart()

void otb::Stopwatch::Restart

(

)

Reset and restart the timer

Referenced by otb::PersistentImageToOGRLayerSegmentationFilter< TImageType, TSegmentationFilter >::ProcessTile().

Start()

void otb::Stopwatch::Start

(

)

Start the timer if not already running

StartNew()

static Stopwatch otb::Stopwatch::StartNew ( )

static

Creates and starts a new stopwatch instance

Referenced by otb::PersistentSamplingFilterBase< TInputImage >::GatherOutputVectors(), otb::PersistentImageToOGRLayerFilter< TImageType >::GenerateData(), otb::VectorDataTransformFilter< TInputVectorData, TOutputVectorData >::GenerateData(), otb::VectorDataToVectorDataFilter< TVectorData, TVectorData >::GenerateData(), otb::VectorDataExtractROI< TVectorData >::GenerateData(), otb::PersistentImageToOGRDataFilter< TImage >::GenerateData(), otb::VectorDataProjectionFilter< TInputVectorData, TOutputVectorData >::GenerateData(), and otb::PersistentImageToOGRLayerSegmentationFilter< TImageType, TSegmentationFilter >::ProcessTile().

Stop()

void otb::Stopwatch::Stop

(

)

Stop the timer if running

Referenced by otb::PersistentSamplingFilterBase< TInputImage >::GatherOutputVectors(), otb::PersistentImageToOGRLayerFilter< TImageType >::GenerateData(), otb::VectorDataTransformFilter< TInputVectorData, TOutputVectorData >::GenerateData(), otb::VectorDataToVectorDataFilter< TVectorData, TVectorData >::GenerateData(), otb::VectorDataExtractROI< TVectorData >::GenerateData(), otb::PersistentImageToOGRDataFilter< TImage >::GenerateData(), otb::VectorDataProjectionFilter< TInputVectorData, TOutputVectorData >::GenerateData(), and otb::PersistentImageToOGRLayerSegmentationFilter< TImageType, TSegmentationFilter >::ProcessTile().

Member Data Documentation

m_ElapsedMilliseconds

DurationType otb::Stopwatch::m_ElapsedMilliseconds

private

Definition at line 88 of file otbStopwatch.h.

m_IsRunning

bool otb::Stopwatch::m_IsRunning

private

Definition at line 89 of file otbStopwatch.h.

m_StartTime

TimepointType otb::Stopwatch::m_StartTime

private

Definition at line 87 of file otbStopwatch.h.

---

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

• otbStopwatch.h