aboutsummaryrefslogtreecommitdiffstats
path: root/include/usrp_uhd/time_spec.hpp
blob: dc16a72aa43095961aa5a0e3f174abb6b29f1b77 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
//
// Copyright 2010 Ettus Research LLC
//

#include <stdint.h>

#ifndef INCLUDED_USRP_UHD_TIME_SPEC_HPP
#define INCLUDED_USRP_UHD_TIME_SPEC_HPP

namespace usrp_uhd{

    /*!
     * A time_spec_t holds a seconds and ticks time value.
     * The temporal width of a tick depends on the device's clock rate.
     * The time_spec_t can be used when setting the time on devices
     * and for controlling the start of streaming for applicable dsps.
     */
    struct time_spec_t{
        uint32_t secs;
        uint32_t ticks;

        /*!
         * Create a time_spec_t that holds a wildcard time.
         * This will have implementation-specific meaning.
         */
        time_spec_t(void){
            secs = ~0;
            ticks = ~0;
        }

        /*!
         * Create a time_spec_t from seconds and ticks.
         * \param new_secs the new seconds
         * \param new_ticks the new ticks (default = 0)
         */
        time_spec_t(uint32_t new_secs, uint32_t new_ticks = 0){
            secs = new_secs;
            ticks = new_ticks;
        }
    };

} //namespace usrp_uhd

#endif /* INCLUDED_USRP_UHD_TIME_SPEC_HPP */