gr-baz Package

baz_time_keeper.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,2013 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23/*
24 * gr-baz by Balint Seeber (http://spench.net/contact)
25 * Information, documentation & samples: http://wiki.spench.net/wiki/gr-baz
26 */
27
28#ifndef INCLUDED_BAZ_TIME_KEEPER_H
29#define INCLUDED_BAZ_TIME_KEEPER_H
30
31#include <gnuradio/sync_block.h>
32//#include <gnuradio/msg_queue.h>
33#include <gnuradio/thread/thread.h>
34
35 class BAZ_API baz_time_keeper;
36
37/*
38 * We use boost::shared_ptr's instead of raw pointers for all access
39 * to gr::blocks (and many other data structures). The shared_ptr gets
40 * us transparent reference counting, which greatly simplifies storage
41 * management issues. This is especially helpful in our hybrid
42 * C++ / Python system.
43 *
44 * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
45 *
46 * As a convention, the _sptr suffix indicates a boost::shared_ptr
47 */
48 typedef boost::shared_ptr<baz_time_keeper> baz_time_keeper_sptr;
49
50/*!
51 * \brief Return a shared_ptr to a new instance of baz_time_keeper.
52 *
53 * To avoid accidental use of raw pointers, baz_time_keeper's
54 * constructor is private. howto_make_square2_ff is the public
55 * interface for creating new instances.
56 */
57 BAZ_API baz_time_keeper_sptr baz_make_time_keeper (int item_size, float sample_rate);
58
59/*!
60 * \brief square2 a stream of floats.
61 * \ingroup block
62 *
63 * This uses the preferred technique: subclassing gr::sync_block.
64 */
65 class BAZ_API baz_time_keeper : public gr::sync_block
66{
67 private:
68 // The friend declaration allows baz_time_keeper to
69 // access the private constructor.
70
71 friend BAZ_API baz_time_keeper_sptr baz_make_time_keeper (int item_size, float sample_rate);
72
73 baz_time_keeper (int item_size, float sample_rate); // private constructor
74
75 int d_item_size;
76 uint64_t d_last_time_seconds, d_first_time_seconds;
77 double d_last_time_fractional_seconds, d_first_time_fractional_seconds;
78 uint64_t d_time_offset;
79 float d_sample_rate;
80 bool d_seen_time;
81 int d_update_count;
82 bool d_ignore_next;
83 gr::thread::mutex d_mutex;
84 pmt::pmt_t d_status_port_id;
85
86 public:
87 ~baz_time_keeper (); // public destructor
88
89 double time(bool relative = false);
90 void ignore_next(bool ignore = true);
91 int update_count(void);
92
93 int work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items);
94};
95
96#endif /* INCLUDED_BAZ_TIME_KEEPER_H */
BAZ_API
#define BAZ_API
Definition: api.h:19
baz_make_time_keeper
BAZ_API baz_time_keeper_sptr baz_make_time_keeper(int item_size, float sample_rate)
Return a shared_ptr to a new instance of baz_time_keeper.
baz_time_keeper
class BAZ_API baz_time_keeper
Definition: baz_time_keeper.h:35
baz_time_keeper
square2 a stream of floats.
Definition: baz_time_keeper.h:66
baz_time_keeper::baz_make_time_keeper
friend BAZ_API baz_time_keeper_sptr baz_make_time_keeper(int item_size, float sample_rate)
Return a shared_ptr to a new instance of baz_time_keeper.
baz_time_keeper::~baz_time_keeper
~baz_time_keeper()
baz_time_keeper::work
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
baz_time_keeper::time
double time(bool relative=false)
baz_time_keeper::update_count
int update_count(void)
baz_time_keeper::ignore_next
void ignore_next(bool ignore=true)