duckdb::BaseProfiler< T > Class Template Reference

Profiler class to measure the elapsed time. More...

#include <duckdb.hpp>

Collaboration diagram for duckdb::BaseProfiler< T >:

Public Member Functions
void	Start ()
	Start the timer.
void	End ()
	End the timer.
void	Reset ()
	Reset the timer.
double	Elapsed () const
idx_t	ElapsedNanos () const

Private Member Functions
time_point< T >	Tick () const
	Current time point.

Private Attributes
time_point< T >	start
	Start time point.
time_point< T >	end
	End time point.
bool	finished = false
	True, if end End() been called.
bool	ran = false
	True, if the timer was ran.

Detailed Description

template<typename T>
class duckdb::BaseProfiler< T >

Profiler class to measure the elapsed time.

Member Function Documentation

Start()

template<typename T >

void duckdb::BaseProfiler< T >::Start ( )

inline

Start the timer.

                 {
        finished = false;
        ran = true;
        start = Tick();
    }

Here is the call graph for this function:

End()

template<typename T >

void duckdb::BaseProfiler< T >::End ( )

inline

End the timer.

               {
        end = Tick();
        finished = true;
    }

Here is the call graph for this function:

Reset()

template<typename T >

void duckdb::BaseProfiler< T >::Reset ( )

inline

Reset the timer.

                 {
        finished = false;
        ran = false;
    }

Elapsed()

template<typename T >

double duckdb::BaseProfiler< T >::Elapsed ( ) const

inline

Returns the elapsed time in seconds. If ran is false, it returns 0. If End() has been called, it returns the total elapsed time, otherwise, returns how far along the timer is right now.

                           {
        if (!ran) {
            return 0;
        }
        auto measured_end = finished ? end : Tick();
        return std::chrono::duration_cast<std::chrono::duration<double>>(measured_end - start).count();
    }

Here is the call graph for this function:

ElapsedNanos()

template<typename T >

idx_t duckdb::BaseProfiler< T >::ElapsedNanos ( ) const

inline

                               {
        if (!ran) {
            return 0;
        }
        auto measured_end = finished ? end : Tick();
        return static_cast<idx_t>(std::chrono::duration_cast<std::chrono::nanoseconds>(measured_end - start).count());
    }

Tick()

template<typename T >

time_point< T > duckdb::BaseProfiler< T >::Tick ( ) const

inlineprivate

Current time point.

                               {
        return T::now();
    }

Here is the caller graph for this function:

---

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

• external/duckdb/duckdb.hpp