l_heartbeat.h

Go to the documentation of this file.

/*
 * $Id: l_heartbeat.h 14984 2013-07-22 23:46:33Z predoehl $
 *
 * Recommended tab width:  4
 */


#ifndef HEARTBEAT_H_PREDOEHL_UOFARIZONAVISION
#define HEARTBEAT_H_PREDOEHL_UOFARIZONAVISION

#include <string>

namespace kjb {


class Heartbeat {
    const std::string m_msg;        
    const unsigned m_mask;          
    const unsigned m_total;         
    const float m_denominator;      
    const time_t m_start_time;      
    unsigned m_progress_counter;    
    const bool m_is_output_to_tty;  

    mutable int m_lastlen;

    std::string thump( bool finalize = false ) const;

public:

    Heartbeat(
        const std::string& message,
        unsigned total = 1,
        unsigned masklen = 10
    );


    std::string beat()
    {
        std::string retval;
        if ( m_is_output_to_tty && 0 == (m_progress_counter & m_mask) )
        {
            retval = thump();   // finalize default value is false
        }
        ++m_progress_counter;
        return retval;
    }

    std::string stop() const
    {
        return thump( /* set finalize to... */ true );
    }
};

}

#endif