StopWatch< T > Class Template Reference

RAII stopwatch using a selectable clock policy. More...

#include <mxvk/include/mxvk/mxvk_stopwatch.hpp>

Public Member Functions
void	Echo (std::string_view name) const
	Print the interval recorded by the clock policy.
StopWatch &	operator= (const StopWatch &)=delete
	Stopwatches cannot be copy-assigned.
StopWatch &	operator= (StopWatch &&)=delete
	Stopwatches cannot be move-assigned.
void	Start (std::string_view name)
	Start a new timed interval.
void	Stop ()
	Stop the current interval and print its duration.
	StopWatch (const StopWatch &)=delete
	Stopwatches cannot be copied.
	StopWatch (std::string_view name)
	Construct and immediately start a stopwatch.
	StopWatch (StopWatch &&)=delete
	Stopwatches cannot be moved.
unsigned long	TimePassed () const
	Query the time elapsed since the most recent Start().
	~StopWatch ()
	Stop and print the timer if it is still running.

Detailed Description

template<ClockPolicy T>
class StopWatch< T >

RAII stopwatch using a selectable clock policy.

Construction starts the timer immediately. Stop() prints the result and is safe to call more than once. If the stopwatch is still running when it is destroyed, the destructor stops it and prints the result automatically.

Template Parameters

T	Clock policy satisfying ClockPolicy.

\par Note:
The stopwatch stores its name as a std::string_view. The referenced string must remain valid for the lifetime of the stopwatch.

Definition at line 133 of file mxvk_stopwatch.hpp.

Constructor & Destructor Documentation

StopWatch() [1/3]

template<ClockPolicy T>

StopWatch< T >::StopWatch ( std::string_view name )

inlineexplicit

Construct and immediately start a stopwatch.

Parameters

name	Descriptive name printed with the timing result.

Definition at line 139 of file mxvk_stopwatch.hpp.

                                            : time_name(name) {
        Start(name);
    }

~StopWatch()

template<ClockPolicy T>

StopWatch< T >::~StopWatch ( )

inline

Stop and print the timer if it is still running.

Definition at line 144 of file mxvk_stopwatch.hpp.

                 {
        if (!m_stopped) {
            Stop();
        }
    }

StopWatch() [2/3]

template<ClockPolicy T>

StopWatch< T >::StopWatch ( const StopWatch< T > & )

delete

Stopwatches cannot be copied.

StopWatch() [3/3]

template<ClockPolicy T>

StopWatch< T >::StopWatch ( StopWatch< T > && )

delete

Stopwatches cannot be moved.

Member Function Documentation

Echo()

template<ClockPolicy T>

void StopWatch< T >::Echo ( std::string_view name ) const

inline

Print the interval recorded by the clock policy.

Parameters

name	Descriptive name shown with the timing result.

Definition at line 188 of file mxvk_stopwatch.hpp.

                                         {
        clock_interface.echo(name);
    }

operator=() [1/2]

template<ClockPolicy T>

StopWatch & StopWatch< T >::operator= ( const StopWatch< T > & )

delete

Stopwatches cannot be copy-assigned.

operator=() [2/2]

template<ClockPolicy T>

StopWatch & StopWatch< T >::operator= ( StopWatch< T > && )

delete

Stopwatches cannot be move-assigned.

Start()

template<ClockPolicy T>

void StopWatch< T >::Start ( std::string_view name )

inline

Start a new timed interval.

Parameters

name	Descriptive name printed with the timing result.

Calling this function restarts the stopwatch and replaces its name.

Definition at line 165 of file mxvk_stopwatch.hpp.

                                    {
        time_name = name;
        m_stopped = false;
        clock_interface.start();
    }

Stop()

template<ClockPolicy T>

void StopWatch< T >::Stop ( )

inline

Stop the current interval and print its duration.

Repeated calls have no effect until Start() begins another interval.

Definition at line 176 of file mxvk_stopwatch.hpp.

                {
        if (m_stopped)
            return;
        clock_interface.stop();
        Echo(time_name);
        m_stopped = true;
    }

TimePassed()

template<ClockPolicy T>

unsigned long StopWatch< T >::TimePassed ( ) const

inline

Query the time elapsed since the most recent Start().

Returns

Elapsed time in the unit defined by the selected clock policy.

SteadyClockPolicy returns milliseconds, while HighResolutionClockPolicy returns nanoseconds.

Definition at line 199 of file mxvk_stopwatch.hpp.

                                     {
        return clock_interface.timePassed();
    }

---

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

• mxvk/include/mxvk/mxvk_stopwatch.hpp