slp::SetupProfiler Class Reference

Records the number of profiler measurements (start/stop pairs) and the average duration between each start and stop call. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/sleipnir/include/sleipnir/util/setup_profiler.hpp>

Public Member Functions
	SetupProfiler (std::string_view name)
	Constructs a SetupProfiler.
void	start ()
	Tell the profiler to start measuring setup time.
void	stop ()
	Tell the profiler to stop measuring setup time.
std::string_view	name () const
	Returns name of measurement to show in diagnostics.
const std::chrono::duration< double > &	duration () const
	Returns the setup duration in milliseconds as a double.

Detailed Description

Records the number of profiler measurements (start/stop pairs) and the average duration between each start and stop call.

Constructor & Destructor Documentation

SetupProfiler()

slp::SetupProfiler::SetupProfiler ( std::string_view name )

inlineexplicit

Constructs a SetupProfiler.

Parameters

name	Name of measurement to show in diagnostics.

Member Function Documentation

duration()

const std::chrono::duration< double > & slp::SetupProfiler::duration ( ) const

inline

Returns the setup duration in milliseconds as a double.

Returns

The setup duration in milliseconds as a double.

name()

std::string_view slp::SetupProfiler::name ( ) const

inline

Returns name of measurement to show in diagnostics.

Returns

Name of measurement to show in diagnostics.

start()

void slp::SetupProfiler::start ( )

inline

Tell the profiler to start measuring setup time.

stop()

void slp::SetupProfiler::stop ( )

inline

Tell the profiler to stop measuring setup time.

---

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

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/sleipnir/include/sleipnir/util/setup_profiler.hpp