base_sink_c.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2013-2014 Sylvain Munaut <tnt@246tNt.com>
*
* This is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this software; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
#ifndef INCLUDED_GR_FOSPHOR_BASE_SINK_C_H
#define INCLUDED_GR_FOSPHOR_BASE_SINK_C_H
#include <gnuradio/fosphor/api.h>
#include <gnuradio/sync_block.h>
#include <gnuradio/fft/window.h>
namespace gr {
namespace fosphor {
/*!
* \brief Base fosphor sink API interface
* \ingroup fosphor
*/
class GR_FOSPHOR_API base_sink_c : public gr::sync_block
{
protected:
base_sink_c(const char *name = NULL);
public:
enum ui_action_t {
DB_PER_DIV_UP,
DB_PER_DIV_DOWN,
REF_UP,
REF_DOWN,
ZOOM_TOGGLE,
ZOOM_WIDTH_UP,
ZOOM_WIDTH_DOWN,
ZOOM_CENTER_UP,
ZOOM_CENTER_DOWN,
RATIO_UP,
RATIO_DOWN,
FREEZE_TOGGLE,
};
virtual void execute_ui_action(enum ui_action_t action) = 0;
virtual void set_frequency_range(const double center,
const double span) = 0;
virtual void set_frequency_center(const double center) = 0;
virtual void set_frequency_span(const double span) = 0;
virtual void set_fft_window(const gr::fft::window::win_type win) = 0;
};
} // namespace fosphor
} // namespace gr
#endif /* INCLUDED_GR_FOSPHOR_BASE_SINK_C_H */
api.h
GR_FOSPHOR_API
#define GR_FOSPHOR_API
Definition: api.h:30
gr::fosphor::base_sink_c
Base fosphor sink API interface.
Definition: base_sink_c.h:38
gr::fosphor::base_sink_c::ui_action_t
ui_action_t
Definition: base_sink_c.h:44
gr::fosphor::base_sink_c::REF_UP
@ REF_UP
Definition: base_sink_c.h:47
gr::fosphor::base_sink_c::ZOOM_CENTER_UP
@ ZOOM_CENTER_UP
Definition: base_sink_c.h:52
gr::fosphor::base_sink_c::DB_PER_DIV_UP
@ DB_PER_DIV_UP
Definition: base_sink_c.h:45
gr::fosphor::base_sink_c::DB_PER_DIV_DOWN
@ DB_PER_DIV_DOWN
Definition: base_sink_c.h:46
gr::fosphor::base_sink_c::ZOOM_TOGGLE
@ ZOOM_TOGGLE
Definition: base_sink_c.h:49
gr::fosphor::base_sink_c::FREEZE_TOGGLE
@ FREEZE_TOGGLE
Definition: base_sink_c.h:56
gr::fosphor::base_sink_c::ZOOM_WIDTH_DOWN
@ ZOOM_WIDTH_DOWN
Definition: base_sink_c.h:51
gr::fosphor::base_sink_c::REF_DOWN
@ REF_DOWN
Definition: base_sink_c.h:48
gr::fosphor::base_sink_c::RATIO_DOWN
@ RATIO_DOWN
Definition: base_sink_c.h:55
gr::fosphor::base_sink_c::ZOOM_CENTER_DOWN
@ ZOOM_CENTER_DOWN
Definition: base_sink_c.h:53
gr::fosphor::base_sink_c::RATIO_UP
@ RATIO_UP
Definition: base_sink_c.h:54
gr::fosphor::base_sink_c::ZOOM_WIDTH_UP
@ ZOOM_WIDTH_UP
Definition: base_sink_c.h:50
gr::fosphor::base_sink_c::execute_ui_action
virtual void execute_ui_action(enum ui_action_t action)=0
gr::fosphor::base_sink_c::base_sink_c
base_sink_c(const char *name=NULL)
gr::fosphor::base_sink_c::set_frequency_range
virtual void set_frequency_range(const double center, const double span)=0
gr::fosphor::base_sink_c::set_frequency_center
virtual void set_frequency_center(const double center)=0
gr::fosphor::base_sink_c::set_frequency_span
virtual void set_frequency_span(const double span)=0
gr::fosphor::base_sink_c::set_fft_window
virtual void set_fft_window(const gr::fft::window::win_type win)=0
gr
Definition: base_sink_c.h:30
fosphor
Definition: private.h:44