Class Now is a practical class for timing based in a high resolution clock. More...

#include <ahNow.H>

Public Types
enum class	Precision { Hours , Minutes , Seconds , Milliseconds , Microseconds , Nanoseconds }
	Precision for timing. More...

using	ClockType = std::chrono::high_resolution_clock

using	TimePointType = ClockType::time_point

using	DurationType = ClockType::duration

Public Member Functions
	Now (bool start_now=false)
	Builds a new object with default values.

	Now (const Precision &_precision, bool start_now=false)
	Builds a new object with parametric precision time.

const Precision &	get_precision () const
	Gets the type of precision.

void	set_precision (const Precision &_precision)
	Sets the type of precision.

TimePointType	start ()
	Sets internally the current time point.

double	elapsed ()
	Calculates the time that has elapsed since the last time start(), elapsed() or delta() was called.

double	delta ()
	Like elapsed().

Static Public Member Functions
static int	to_int (Precision p)

static TimePointType	current_time_point ()
	Gets the current time point.

static double	compute_time_diff (const TimePointType &rtp, const TimePointType &ltp, const Precision &precision)
	Calculates the time that has elapsed between two time points.

static double	elapsed (const TimePointType &tp, const Precision &precision=Precision::Milliseconds)
	Calculates the time that has elapsed since a given time point.

static double	delta (const TimePointType &tp, const Precision &precision=Precision::Milliseconds)
	Like elapsed(const TimePointType & tp, const Precision & precision = MILLISECONDS).

Private Attributes
TimePointType	tp

Precision	precision

Static Private Attributes
static const double	precision_values []

Detailed Description

Class Now is a practical class for timing based in a high resolution clock.

An instance of this class allows to measure elapsed time between two instants.

Usage example:

Now now;
now.start();
// Any block of code
std::cout << "Time elapsed: " << now.elapsed() << "ms\n";

Furthermore you may use the static methods just like that:

auto t = Now::current_time_point();
// Any block of code
std::cout << "Time elapsed: " << Now::elapsed(t) << "ms\n";

Author: Alejandro J. Mujica

Definition at line 78 of file ahNow.H.

Member Typedef Documentation

◆ ClockType

using Aleph::Now::ClockType = std::chrono::high_resolution_clock

Definition at line 97 of file ahNow.H.

◆ DurationType

using Aleph::Now::DurationType = ClockType::duration

Definition at line 99 of file ahNow.H.

◆ TimePointType

using Aleph::Now::TimePointType = ClockType::time_point

Definition at line 98 of file ahNow.H.

Member Enumeration Documentation

◆ Precision

enum class Aleph::Now::Precision

strong

Precision for timing.

Enumerator
Hours
Minutes
Seconds
Milliseconds
Microseconds
Nanoseconds

Definition at line 82 of file ahNow.H.

Constructor & Destructor Documentation

◆ Now() [1/2]

Aleph::Now::Now ( bool start_now = false )

inline

Builds a new object with default values.

Builds a new object with default time point and precision in MILLISECONDS. You may set the object to start counting time immediately by setting the parameter start_now in true. This constructor can be used as parametric or default.

Parameters

start_now If true, then the object starts counting the time immediately. By default is false.

See also: Precision

Definition at line 143 of file ahNow.H.

References Aleph::maps(), and start().

◆ Now() [2/2]

Aleph::Now::Now	(	const Precision &	_precision,
		bool	start_now = `false`
	)

inline

Builds a new object with parametric precision time.

Builds a new object with default time point and precision given as a parameter. You may set the object to start counting time immediately by setting the parameter start_now in true.

Parameters