toolbox::utils::simple_timer_interface_t Class Reference

Interface for managing a collection of timers. More...

#include <timer.hpp>

Inheritance diagram for toolbox::utils::simple_timer_interface_t:

Public Member Functions
virtual	~simple_timer_interface_t ()=default
	Virtual destructor to ensure proper cleanup.
virtual void	start (int index)=0
	Start the timer at specified index.
virtual void	stop (int index)=0
	Stop the timer at specified index.
virtual void	reset (int index)=0
	Reset the timer at specified index.
virtual void	print_stats (int index) const =0
	Print statistics for the timer at specified index.
virtual void	print_all_stats () const =0
	Print statistics for all timers.
virtual auto	elapsed_time_ms (int index) const -> double=0
	Get elapsed time in milliseconds for specified timer.
virtual auto	elapsed_time (int index) const -> double=0
	Get elapsed time in seconds for specified timer.
virtual auto	size () const -> size_t=0
	Get the number of timers in the collection.

Detailed Description

Interface for managing a collection of timers.

This interface provides a unified way to manage multiple timers through a single interface. It supports starting, stopping, resetting, and querying timers by index.

// Basic usage
simple_timer_interface_t* timers = create_timer(3);
timers->start(0);
// ... perform operation ...
timers->stop(0);
double elapsed = timers->elapsed_time_ms(0);
timers->print_all_stats();
delete_timer(&timers);

Constructor & Destructor Documentation

~simple_timer_interface_t()

virtual toolbox::utils::simple_timer_interface_t::~simple_timer_interface_t ( )

virtualdefault

Virtual destructor to ensure proper cleanup.

Member Function Documentation

elapsed_time()

virtual auto toolbox::utils::simple_timer_interface_t::elapsed_time ( int  index ) const -> double

pure virtual

Get elapsed time in seconds for specified timer.

Parameters

index

The index of the timer to query

Returns

Elapsed time in seconds

Implemented in toolbox::utils::simple_timer_array_t.

elapsed_time_ms()

virtual auto toolbox::utils::simple_timer_interface_t::elapsed_time_ms ( int  index ) const -> double

pure virtual

Get elapsed time in milliseconds for specified timer.

Parameters

index

The index of the timer to query

Returns

Elapsed time in milliseconds

Implemented in toolbox::utils::simple_timer_array_t.

print_all_stats()

virtual void toolbox::utils::simple_timer_interface_t::print_all_stats ( ) const

pure virtual

Print statistics for all timers.

Implemented in toolbox::utils::simple_timer_array_t.

print_stats()

virtual void toolbox::utils::simple_timer_interface_t::print_stats ( int  index ) const

pure virtual

Print statistics for the timer at specified index.

Parameters

index

The index of the timer to print

Implemented in toolbox::utils::simple_timer_array_t.

reset()

virtual void toolbox::utils::simple_timer_interface_t::reset ( int  index )

pure virtual

Reset the timer at specified index.

Parameters

index

The index of the timer to reset

Implemented in toolbox::utils::simple_timer_array_t.

size()

virtual auto toolbox::utils::simple_timer_interface_t::size ( ) const -> size_t

pure virtual

Get the number of timers in the collection.

Returns

Number of timers

Implemented in toolbox::utils::simple_timer_array_t.

start()

virtual void toolbox::utils::simple_timer_interface_t::start ( int  index )

pure virtual

Start the timer at specified index.

Parameters

index

The index of the timer to start

Implemented in toolbox::utils::simple_timer_array_t.

stop()

virtual void toolbox::utils::simple_timer_interface_t::stop ( int  index )

pure virtual

Stop the timer at specified index.

Parameters

index

The index of the timer to stop

Implemented in toolbox::utils::simple_timer_array_t.

---

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

• src/include/cpp-toolbox/utils/timer.hpp