TimeService.hpp

Go to the documentation of this file.

/***************************************************************************
 tag: Peter Soetens  Wed Apr 17 16:01:36 CEST 2002  TimeService.h

                       TimeService.h -  description
                          -------------------
   begin                : Wed April 17 2002
   copyright            : (C) 2002 Peter Soetens
   email                : peter.soetens@mech.kuleuven.ac.be

 ***************************************************************************
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU General Public                   *
 *   License as published by the Free Software Foundation;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   This library 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     *
 *   General Public License for more details.                              *
 *                                                                         *
 *   You should have received a copy of the GNU General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/


#ifndef RTT_TIME_SERVICE_HPP
#define RTT_TIME_SERVICE_HPP

#include "Time.hpp"
#include "../rtt-config.h"

namespace RTT
{ namespace os {


    class RTT_API TimeService
    {
    public:
        typedef double Seconds;

        typedef long secs;

        typedef long msecs;

        typedef long usecs;

        typedef long long nsecs;

        typedef long long ticks;

    public:
        static TimeService* Instance();

        static bool Release();

        virtual ~TimeService();

        ticks ticksGet() const { return getTicks(); }

        ticks getTicks() const;

        ticks ticksGet( ticks &relativeTime ) const { return getTicks( relativeTime ); }

        ticks getTicks( ticks &relativeTime ) const;

        ticks ticksSince( ticks relativeTime ) const;

        Seconds secondsGet( ticks &relativeTime ) const { return getSeconds(relativeTime); }

        Seconds getSeconds( ticks &relativeTime ) const;

        Seconds secondsSince( ticks relativeTime ) const;

        Seconds secondsChange( Seconds delta );

        ticks ticksChange( ticks delta );

        void enableSystemClock( bool yes_no );

        bool systemClockEnabled() const;

        nsecs getNSecs() const;

        nsecs getNSecs( nsecs &relativeTime ) const;

        static ticks nsecs2ticks( const nsecs m );

        static nsecs ticks2nsecs( const ticks t );

        static const ticks InfiniteTicks;

        static const nsecs InfiniteNSecs;

        static const Seconds InfiniteSeconds;
    protected:

        TimeService();

    private:

        static TimeService* _instance;

        ticks offset;

        bool use_clock;
    };
}} // namespace RTT

#endif