mars::MPerfType Class Reference

The MPerfType class Class of performance entry types. More...

#include </home/runner/work/mars_lib/mars_lib/source/mars/include/mars/m_perf.h>

Collaboration diagram for mars::MPerfType:

Public Member Functions
bool	AddStart ()
	AddStart Adds start time to time buffer of the current instance.
bool	AddStop ()
	AddStop Adds stop time to time buffer of the current instance.
std::vector< double >	get_start_times ()
	get_start_times Returns a full vector of all start times
std::vector< double >	get_stop_times ()
	get_stop_times Returns a full vector of all stop times
double	get_mean ()
	get_mean Returns the mean of the duration times of the current instance
double	get_std ()
	get_std Returns the std of the mean for the duration times of the current instance
double	get_max ()
	get_max Returns the max of the duration times of the current instance
double	get_min ()
	get_min Returns the min of the duration times of the current instance
std::vector< double >	get_diff_vec ()
	get_diff_vec Returns a vector with durations for all entries
int	get_size ()
	get_size Gets the size of all start stop time combinations

Private Types
using	time_type = std::chrono::high_resolution_clock::time_point
	time_type Type which the timer isntance returns

Private Member Functions
time_type	get_time ()
	get_time Get current time

Private Attributes
std::string	name_
	name_ Name of the current tracking instance
std::vector< time_type >	start_
	start_ Vector of tracked starting times
std::vector< time_type >	stop_
	stop_ Vector of tracked stopping times
bool	is_running_ { false }
	is_running_ Indicator if the current instance is already tracking a duration

Detailed Description

The MPerfType class Class of performance entry types.

Represents one profiling entity and handles time tracking and statistical operations

Member Typedef Documentation

time_type

using mars::MPerfType::time_type = std::chrono::high_resolution_clock::time_point

private

time_type Type which the timer isntance returns

Member Function Documentation

AddStart()

bool mars::MPerfType::AddStart

(

)

AddStart Adds start time to time buffer of the current instance.

Returns

AddStop()

bool mars::MPerfType::AddStop

(

)

AddStop Adds stop time to time buffer of the current instance.

Returns

get_start_times()

std::vector< double > mars::MPerfType::get_start_times

(

)

get_start_times Returns a full vector of all start times

Returns

get_stop_times()

std::vector< double > mars::MPerfType::get_stop_times

(

)

get_stop_times Returns a full vector of all stop times

Returns

get_mean()

double mars::MPerfType::get_mean

(

)

get_mean Returns the mean of the duration times of the current instance

Returns

get_std()

double mars::MPerfType::get_std

(

)

get_std Returns the std of the mean for the duration times of the current instance

Returns

get_max()

double mars::MPerfType::get_max

(

)

get_max Returns the max of the duration times of the current instance

Returns

get_min()

double mars::MPerfType::get_min

(

)

get_min Returns the min of the duration times of the current instance

Returns

get_diff_vec()

std::vector< double > mars::MPerfType::get_diff_vec

(

)

get_diff_vec Returns a vector with durations for all entries

Returns

get_size()

int mars::MPerfType::get_size

(

)

get_size Gets the size of all start stop time combinations

Returns

get_time()

time_type mars::MPerfType::get_time ( )

private

get_time Get current time

Returns

Member Data Documentation

name_

std::string mars::MPerfType::name_

private

name_ Name of the current tracking instance

start_

std::vector<time_type> mars::MPerfType::start_

private

start_ Vector of tracked starting times

stop_

std::vector<time_type> mars::MPerfType::stop_

private

stop_ Vector of tracked stopping times

is_running_

bool mars::MPerfType::is_running_ { false }

private

is_running_ Indicator if the current instance is already tracking a duration

{ false };

---

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

• m_perf.h