GNU Radio's TPMS Package
burst_detector.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2014 Jared Boone <jared@sharebrained.com>.
4  *
5  * This is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3, or (at your option)
8  * any later version.
9  *
10  * This software is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this software; see the file COPYING. If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street,
18  * Boston, MA 02110-1301, USA.
19  */
20 
21 #ifndef INCLUDED_TPMS_BURST_DETECTOR_H
22 #define INCLUDED_TPMS_BURST_DETECTOR_H
23 
24 #include <tpms/api.h>
25 #include <gnuradio/block.h>
26 
27 namespace gr {
28  namespace tpms {
29 
30  /*!
31  * \brief Identify and tag stream ranges that contain significant bursts of energy.
32  * \ingroup tpms
33  *
34  */
35  class TPMS_API burst_detector : virtual public gr::block
36  {
37  public:
38  typedef boost::shared_ptr<burst_detector> sptr;
39 
40  /*!
41  * \brief Return a shared_ptr to a new instance of tpms::burst_detector.
42  *
43  * To avoid accidental use of raw pointers, tpms::burst_detector's
44  * constructor is in a private implementation
45  * class. tpms::burst_detector::make is the public interface for
46  * creating new instances.
47  */
48  static sptr make();
49  };
50 
51  } // namespace tpms
52 } // namespace gr
53 
54 #endif /* INCLUDED_TPMS_BURST_DETECTOR_H */
55 
Identify and tag stream ranges that contain significant bursts of energy.
Definition: burst_detector.h:35
Definition: ask_env.h:27
boost::shared_ptr< burst_detector > sptr
Definition: burst_detector.h:38
#define TPMS_API
Definition: api.h:29