se::PerfStats Struct Reference

#include <perfstats.hpp>

Classes
struct	Results
struct	Stats

Public Types
enum	Type {   BOOL , COORDINATES , COUNT , CURRENT ,   DISTANCE , DOUBLE , DURATION , ENERGY ,   FRAME , FREQUENCY , INT , ITERATION ,   MEMORY , ORIENTATION , PERCENTAGE , POSITION ,   POWER , TIME , UNDEFINED , VOLTAGE ,   VOLUME }

Public Member Functions
	PerfStats ()
std::string	createHeaderString ()
std::string	createDataIterString ()
std::string	createDataIterString (const size_t iter)
std::string	createDataString ()
const Stats &	get (const std::string &key) const
double	sample (const std::string &key, const double value, const Type type=COUNT)
double	sampleT_WB (const Eigen::Isometry3f &T_WB)
double	sampleDurationStart (const std::string &key)
double	sampleDurationEnd (const std::string &key)
void	setFilestream (std::ofstream *filestream)
void	setIter (const size_t iter)
	Set the current iteration and add it to the stats.
void	writeToFilestream ()
	Write performance stats to filestream.
void	writeToOStream (std::ostream &ostream)
void	writeSummaryToOStream (std::ostream &ostream, const bool include_iter_data=true)

Static Public Member Functions
static double	timeNow ()
	Return the current seconds since the epoch, as measured by std::chrono::steady_clock.

Public Attributes
std::vector< PerfStats::Type >	header_order_
	The order the different types are added to the output.
int	insertion_idx_
	The index of the next stat to be inserted to performance stats.
size_t	iter_
	The current iteration.
std::map< int, std::string >	order_
	The order the stats are added to the stats_ map | map idx -> stat name.
std::map< std::string, Stats >	stats_
	The map stat name -> stat.
std::ofstream *	filestream_
bool	filestream_aligned_
size_t	filestream_last_iter_
std::streampos	filestream_pos_
bool	ostream_aligned_
size_t	ostream_last_iter_

Member Enumeration Documentation

Type

enum se::PerfStats::Type

Enumerator
BOOL
COORDINATES
COUNT
CURRENT
DISTANCE
DOUBLE
DURATION
ENERGY
FRAME
FREQUENCY
INT
ITERATION
MEMORY
ORIENTATION
PERCENTAGE
POSITION
POWER
TIME
UNDEFINED
VOLTAGE
VOLUME

Constructor & Destructor Documentation

PerfStats()

se::PerfStats::PerfStats

(

)

Member Function Documentation

createHeaderString()

std::string se::PerfStats::createHeaderString

(

)

Returns

The tab separated stats names with units.

createDataIterString() [1/2]

std::string se::PerfStats::createDataIterString

(

)

createDataIterString() [2/2]

std::string se::PerfStats::createDataIterString

(

const size_t

iter

)

createDataString()

std::string se::PerfStats::createDataString

(

)

get()

const Stats & se::PerfStats::get ( const std::string &  key ) const

inline

Parameters

[in]

key

The key to the requested stats.

Returns

The stats cooresponding

sample()

double se::PerfStats::sample	(	const std::string &	key,
		const double	value,
		const Type	type = COUNT
	)

sampleT_WB()

double se::PerfStats::sampleT_WB

(

const Eigen::Isometry3f &

T_WB

)

sampleDurationStart()

double se::PerfStats::sampleDurationStart

(

const std::string &

key

)

sampleDurationEnd()

double se::PerfStats::sampleDurationEnd

(

const std::string &

key

)

setFilestream()

void se::PerfStats::setFilestream

(

std::ofstream *

filestream

)

setIter()

void se::PerfStats::setIter ( const size_t  iter )

inline

Set the current iteration and add it to the stats.

Parameters

[in]

iter

writeToFilestream()

void se::PerfStats::writeToFilestream

(

)

Write performance stats to filestream.

The first time the function is called the header will be added. If the

writeToOStream()

void se::PerfStats::writeToOStream

(

std::ostream &

ostream

)

writeSummaryToOStream()

void se::PerfStats::writeSummaryToOStream	(	std::ostream &	ostream,
		const bool	include_iter_data = true
	)

timeNow()

static double se::PerfStats::timeNow ( )

static

Return the current seconds since the epoch, as measured by std::chrono::steady_clock.

Member Data Documentation

header_order_

std::vector<PerfStats::Type> se::PerfStats::header_order_

Initial value:

= {
        FRAME,    ITERATION, TIME, DURATION, MEMORY,     POSITION, ORIENTATION,
        DISTANCE, FREQUENCY, BOOL, POWER,    ENERGY,     CURRENT,  VOLTAGE,
        VOLUME,   COUNT,     INT,  DOUBLE,   PERCENTAGE, UNDEFINED}

The order the different types are added to the output.

insertion_idx_

int se::PerfStats::insertion_idx_

The index of the next stat to be inserted to performance stats.

iter_

size_t se::PerfStats::iter_

The current iteration.

order_

std::map<int, std::string> se::PerfStats::order_

The order the stats are added to the stats_ map | map idx -> stat name.

stats_

std::map<std::string, Stats> se::PerfStats::stats_

The map stat name -> stat.

filestream_

std::ofstream* se::PerfStats::filestream_

filestream_aligned_

bool se::PerfStats::filestream_aligned_

filestream_last_iter_

size_t se::PerfStats::filestream_last_iter_

filestream_pos_

std::streampos se::PerfStats::filestream_pos_

ostream_aligned_

bool se::PerfStats::ostream_aligned_

ostream_last_iter_

size_t se::PerfStats::ostream_last_iter_

---

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

• include/se/common/perfstats.hpp