WireCell::TimeKeeper Class Reference

#include <TimeKeeper.h>

Public Types
typedef boost::posix_time::ptime	ptime
typedef boost::posix_time::time_duration	deltat
typedef std::pair< ptime, std::string >	event

Public Member Functions
	TimeKeeper (const std::string &msg="start", ptime starting_time=boost::posix_time::microsec_clock::local_time())
	~TimeKeeper ()
ptime	start_time () const
	Return the time at which this time keeper was started. More...
ptime	last_time () const
	Return the time of the last event. More...
deltat	last_duration () const
	Return the duration between the last two events. More...
deltat	since (ptime now=boost::posix_time::microsec_clock::local_time()) const
	Return the time duration between "now" and the start time. More...
std::string	operator() (std::string msg="<tick>", ptime now=boost::posix_time::microsec_clock::local_time())
	Record an event. More...
std::string	summary () const
	Return summary up to now. More...
event	operator[] (int ind) const
	Return event by index. More...

Private Member Functions
std::string	emit (int ind) const
	Emit a formatted message for the given event index. More...

Private Attributes
std::vector< event >	m_events

Detailed Description

A helper class to give some time keeping.

Use like

TimeKeeper tk("starting"); ... tk("starting long calculation...."); do_long_calculation(); tk("...done"); ... info(tk.summary());

Definition at line 21 of file TimeKeeper.h.

Member Typedef Documentation

typedef boost::posix_time::time_duration WireCell::TimeKeeper::deltat

Definition at line 24 of file TimeKeeper.h.

typedef std::pair<ptime, std::string> WireCell::TimeKeeper::event

Definition at line 25 of file TimeKeeper.h.

typedef boost::posix_time::ptime WireCell::TimeKeeper::ptime

Definition at line 23 of file TimeKeeper.h.

Constructor & Destructor Documentation

TimeKeeper::TimeKeeper	(	const std::string &	msg = "start",
		ptime	starting_time = boost::posix_time::microsec_clock::local_time()
	)

Definition at line 8 of file TimeKeeper.cxx.

{
    m_events.push_back(event(starting_time, msg));
}

TimeKeeper::~TimeKeeper

(

)

Definition at line 13 of file TimeKeeper.cxx.

{
}

Member Function Documentation

std::string TimeKeeper::emit ( int  ind ) const

private

Emit a formatted message for the given event index.

Definition at line 57 of file TimeKeeper.cxx.

{
    while (ind < 0) { ind += m_events.size();}
    int prev_ind = ind-1;
    if (prev_ind<0) prev_ind=0;
    const event& prev = (*this)[prev_ind];
    const event& evt = (*this)[ind];

    deltat from_start = since(evt.first);
    deltat from_last = evt.first - prev.first;

    stringstream ss;
    ss << "TICK: " << from_start.total_milliseconds() << " ms "
       << "(this: " << from_last.total_milliseconds() << " ms) "
       << evt.second;
    return ss.str();
}

TimeKeeper::deltat TimeKeeper::last_duration

(

)

const

Return the duration between the last two events.

Definition at line 31 of file TimeKeeper.cxx.

{
    return (*this)[-1].first - (*this)[-2].first;
}

boost::posix_time::ptime TimeKeeper::last_time

(

)

const

Return the time of the last event.

Definition at line 27 of file TimeKeeper.cxx.

{
    return (*this)[-1].first;
}

std::string TimeKeeper::operator()	(	std::string	msg = "<tick>",
		ptime	now = boost::posix_time::microsec_clock::local_time()
	)

Record an event.

Definition at line 17 of file TimeKeeper.cxx.

{
    m_events.push_back(event(now, msg));
    return emit(-1);
}

TimeKeeper::event TimeKeeper::operator[]

(

int

ind

)

const

Return event by index.

Definition at line 41 of file TimeKeeper.cxx.

{
    while (ind < 0) { ind += m_events.size();}

    return m_events[ind];
}

boost::posix_time::time_duration TimeKeeper::since

(

ptime

now = boost::posix_time::microsec_clock::local_time()

)

const

Return the time duration between "now" and the start time.

Definition at line 36 of file TimeKeeper.cxx.

{
    return now - start_time();
}

boost::posix_time::ptime TimeKeeper::start_time

(

)

const

Return the time at which this time keeper was started.

Definition at line 23 of file TimeKeeper.cxx.

{
    return (*this)[0].first;
}

std::string TimeKeeper::summary

(

)

const

Return summary up to now.

Definition at line 48 of file TimeKeeper.cxx.

{
    stringstream ss;
    for (size_t ind=0; ind<m_events.size(); ++ind) {
        ss << this->emit(ind) << "\n";
    }
    return ss.str();
}

Member Data Documentation

std::vector< event > WireCell::TimeKeeper::m_events

private

Definition at line 60 of file TimeKeeper.h.

---

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

• wire-cell-build/util/inc/WireCellUtil/TimeKeeper.h
• wire-cell-build/util/src/TimeKeeper.cxx