Clock.hpp

Go to the documentation of this file.

/*
 * This file is part of the DUDS project. It is subject to the BSD-style
 * license terms in the LICENSE file found in the top-level directory of this
 * distribution and at https://github.com/jjackowski/duds/blob/master/LICENSE.
 * No part of DUDS, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 *
 * Copyright (C) 2017  Jeff Jackowski
 */
#ifndef CLOCK_HPP
#define CLOCK_HPP

#include <duds/hardware/devices/Device.hpp>
#include <duds/hardware/devices/DeviceErrors.hpp>
#include <boost/uuid/name_generator.hpp>

namespace duds { namespace hardware { namespace devices {

namespace clocks {

// ___________________________________________________________________________
// Are these items needed?

typedef duds::data::GenericSample<duds::time::interstellar::NanoTime, float>
    NanoTimeSample;

typedef duds::data::GenericSample<duds::time::interstellar::FemtoTime, double>
    FemtoTimeSample;

typedef NanoTimeSample   TimeSample;

// ___________________________________________________________________________


struct ClockError : DeviceError { };

template<class SVT, class SQT, class TVT, class TQT>
class GenericClock :
public duds::hardware::devices::GenericDevice<SVT, SQT, TVT, TQT> {
public:
    // copied from base class; cannot use from derived classes without scope
    typedef duds::data::GenericMeasurement<SVT, SQT, TVT, TQT>  Measurement;
    typedef std::shared_ptr<GenericClock < SVT, SQT, TVT, TQT > >  ClockSptr;
protected:
    template<class Ratio, class Src, class Dest>
    static void convert(Dest &dest, const Src &src) {
        dest = (Dest)src * ((Dest)(Ratio::num) / (Dest)(Ratio::den));
    }
    template<class Ratio, class IST, class Src>
    static void convertIST(IST &dest, const Src &src) {
        // src * Ratio / IST::period
        typedef std::ratio_divide<Ratio, typename IST::period> r;
        dest = IST(typename IST::duration((src * r::num) / r::den));
    }
    #if !defined(HAVE_INT128) | defined(DOXYGEN)

    template<class Ratio, class IST>
    static void convertIST(IST &dest, const duds::data::int128_t &src) {
        // src * Ratio / IST::period
        typedef std::ratio_divide<Ratio, typename IST::period> r;
        dest = IST(typename IST::duration(
            ((src * r::num) / r::den).template convert_to<typename IST::rep>()
        ));
    }
    #endif

    template<class Ratio, class Src>
    static void convert(
        duds::time::interstellar::FemtoTime &dest,
        const Src &src)
    {
        convertIST<Ratio, duds::time::interstellar::FemtoTime>(dest, src);
    }
    template<class Ratio, class Src>
    static void convert(duds::time::interstellar::NanoTime &dest, const Src &src) {
        convertIST<Ratio, duds::time::interstellar::NanoTime>(dest, src);
    }
    template<class Ratio, class Src>
    static void convert(duds::data::GenericValue &dest, const Src &src) {
        // same as Femtoseconds
        typedef std::ratio_divide<Ratio, std::femto> r;
        duds::time::interstellar::Femtoseconds::rep bigsrc = src;
        dest = duds::time::interstellar::Femtoseconds(
            (src * r::num) / r::den
        );
    }
    GenericClock() = delete;
    using duds::hardware::devices::GenericDevice<SVT, SQT, TVT, TQT>::sens;
    GenericClock(const boost::uuids::uuid &id) :
    duds::hardware::devices::GenericDevice<SVT, SQT, TVT, TQT>(id) {
        boost::uuids::name_generator_latest g(id);
        sens.push_back(Sensor::make(this, g("clock"), 0));
    }
public:
    //using Something::sharedPtr; // doesn't help; no effect
    operator ClockSptr () const {
        return Something::sharedPtr< GenericClock< SVT, SQT, TVT, TQT > >();
    }
    virtual void sampleTime(typename Measurement::TimeSample &time) = 0;
    virtual bool unambiguous() const noexcept = 0;
    typename Measurement::TimeSample sampleTime() {
        typename Measurement::TimeSample ts;
        sampleTime(ts);
        return ts;
    }
    #ifdef DOXYGEN
    // Additional documentation for clock driver requirements. The functions
    // are defined in GenericDevice.
    virtual void sample() = 0;
    virtual void sample(const ClockSptr &clock) = 0;
    #endif
};

typedef GenericClock<
    duds::data::GenericValue,
    double,
    duds::time::interstellar::NanoTime,
    float
>  Clock;

typedef std::shared_ptr<Clock>  ClockSptr;

} } } }

#endif        //  #ifndef CLOCK_HPP