localhistory.h

/*
 * Orca-Robotics Project: Components for robotics
 *               http://orca-robotics.sf.net/
 * Copyright (c) 2004-2009 Alex Brooks, Alexei Makarenko, Tobias Kaupp
 *
 * This distribution is licensed to you under the terms described in
 * the LICENSE file included in this distribution.
 *
 */

#ifndef HYDROICEUTIL_LOCAL_HISTORY_H
#define HYDROICEUTIL_LOCAL_HISTORY_H

#include <hydroutil/history.h>
#include <hydroutil/properties.h>
#include <hydroutil/uncopyable.h>
#include <gbxsickacfr/gbxiceutilacfr/timer.h>

#include <IceUtil/Mutex.h>
#include <memory>

namespace hydroiceutil
{

class LocalHistory : public hydroutil::History,
                    public hydroutil::Uncopyable
{
public:
    LocalHistory( const hydroutil::Properties& props=hydroutil::Properties() );
    ~LocalHistory();

    // from hydroutil::History
    virtual void report( const std::string& message="" );
    virtual bool isEnabled() const { return enabled_; };
    virtual int autoSaveInterval() const { return autoSaveInterval_; };

private:

    virtual void flush();
    virtual void maybeFlush();

    // these are not touched after the constructor (no need to protect them)
    bool enabled_;
    int autoSaveInterval_;

    IceUtil::Mutex mutex_;

    std::string message_;
    std::auto_ptr<std::fstream> file_;
    // the starting write position in the history file.
    std::streampos startPos_;
    // line width used for history (it is the maximum length of all progress
    // reports so far)
    int lineWidth_;

    gbxiceutilacfr::Timer runTimer_;
    gbxiceutilacfr::Timer flushTimer_;

    // currently not using these
    hydroutil::Properties properties_;
};

} // namespace

#endif