clocked_time_stamp.h

// This file is part of snark, a generic and flexible library 
// for robotics research.
//
// Copyright (C) 2011 The University of Sydney
//
// snark is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 3 of the License, or (at your option) any later version.
//
// snark is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License 
// for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with snark. If not, see <http://www.gnu.org/licenses/>.

#ifndef SNARK_CLOCKED_TIMESTAMP
#define SNARK_CLOCKED_TIMESTAMP

#ifndef WIN32
#include <stdlib.h>
#endif
#include <boost/noncopyable.hpp>
#include <snark/timing/time.h>

namespace snark{ namespace timing {

class clocked_time_stamp : public boost::noncopyable
{
    public:
        clocked_time_stamp( boost::posix_time::time_duration period );
        
        ~clocked_time_stamp();
        
        boost::posix_time::ptime adjusted( const boost::posix_time::ptime& t, std::size_t ticks = 1 );
        
        boost::posix_time::ptime adjusted( const boost::posix_time::ptime& t, boost::posix_time::time_duration period, std::size_t ticks = 1 );
        
        boost::posix_time::time_duration period() const;
        
        void reset();
            
    private:
        class impl;
        impl* m_pimpl;
};

} } // namespace snark{ namespace timing

#endif /*SNARK_CLOCKED_TIMESTAMP*/