LogTime Struct Reference

#include <exploragram/hexdom/time_log.h>

Public Member Functions
void	add_step (const std::string &name)
void	start_section (const std::string &secname, const std::string &name="begin section")
void	end_section ()
void	add_value (std::string str, double val)
void	add_string (std::string str, std::string val)
void	show ()
void	drop_file (std::string filename, bool append=false, unsigned int timing_depth=1000)
void	set_suffix (const std::string &suffix)

Detailed Description

LogTime reports a hierarchical execution pipeline: A logger outputs the steps during execution It summarizes execution time in each step It outputs important values (stats) at the end of the execution

Definition at line 57 of file time_log.h.

Constructor & Destructor Documentation

LogTime()

LogTime::LogTime ( )

inline

Definition at line 63 of file time_log.h.

~LogTime()

LogTime::~LogTime ( )

inline

Definition at line 64 of file time_log.h.

Member Function Documentation

add_step()

void LogTime::add_step

(

const std::string &

name

)

put it before starting a new task of the pipeline

add_string()

void LogTime::add_string	(	std::string	str,
		std::string	val
	)

values are used to get feedback (mostly quality stats)

add_value()

void LogTime::add_value	(	std::string	str,
		double	val
	)

values are used to get feedback (mostly quality stats)

drop_file()

void LogTime::drop_file	(	std::string	filename,
		bool	append = false,
		unsigned int	timing_depth = 1000
	)

drop_file is to have the summary in a file.

set_suffix()

void LogTime::set_suffix ( const std::string &  suffix )

inline

Definition at line 98 of file time_log.h.

show()

void LogTime::show

(

)

show is to have the summary in the console

start_section()

void LogTime::start_section	(	const std::string &	secname,
		const std::string &	name = "begin section"
	)

start/end section to define tasks that will be split into smaller tasks

---

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

• exploragram/hexdom/time_log.h