time_spec.hpp

Go to the documentation of this file.

//
// Copyright 2010-2012 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#pragma once

#include <uhd/config.hpp>
#include <stdint.h>
#include <boost/operators.hpp>

namespace uhd {

class UHD_API time_spec_t : boost::additive<time_spec_t>,
                            boost::additive<time_spec_t, double>,
                            boost::totally_ordered<time_spec_t>
{
public:
    // A special value that signifies immediate execution
    static constexpr double ASAP = 0.0;

    time_spec_t(double secs = 0);

    time_spec_t(int64_t full_secs, double frac_secs = 0);

    time_spec_t(int64_t full_secs, long tick_count, double tick_rate);

    static time_spec_t from_ticks(long long ticks, double tick_rate);

    long get_tick_count(double tick_rate) const;

    long long to_ticks(const double tick_rate) const;

    double get_real_secs(void) const;

    int64_t get_full_secs(void) const;

    double get_frac_secs(void) const;

    time_spec_t& operator+=(const time_spec_t&);
    time_spec_t& operator+=(double&);
    time_spec_t& operator-=(const time_spec_t&);
    time_spec_t& operator-=(double&);

    // private time storage details
private:
    int64_t _full_secs;
    double _frac_secs;
};

UHD_API bool operator==(const time_spec_t&, const time_spec_t&);

UHD_API bool operator<(const time_spec_t&, const time_spec_t&);

UHD_INLINE int64_t time_spec_t::get_full_secs(void) const
{
    return this->_full_secs;
}

UHD_INLINE double time_spec_t::get_frac_secs(void) const
{
    return this->_frac_secs;
}

} // namespace uhd