doc/doxygen-3.5.1/gr__oscope__sink__x_8h_source.html

00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2003,2004 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022
00023 #ifndef INCLUDED_GR_OSCOPE_SINK_X_H
00024 #define INCLUDED_GR_OSCOPE_SINK_X_H
00025
00026 #include <gr_core_api.h>
00027 #include <gr_sync_block.h>
00028 #include <gr_trigger_mode.h>
00029
00030 class gr_oscope_guts;
00031
00032 /*!
00033  * \brief Abstract class for python oscilloscope module.
00034  * \ingroup sink_blk
00035  *
00036  * Don't instantiate this.  Use gr_oscope_sink_f or gr_oscope_sink_c instead.
00037  */
00038 class GR_CORE_API gr_oscope_sink_x : public gr_sync_block
00039 {
00040 protected:
00041   double                         d_sampling_rate;
00042   gr_oscope_guts                *d_guts;
00043
00044   gr_oscope_sink_x (const std::string name,
00045                     gr_io_signature_sptr input_sig,
00046                     double sampling_rate);
00047
00048 public:
00049   ~gr_oscope_sink_x ();
00050
00051   bool set_update_rate (double update_rate);
00052   bool set_decimation_count (int decimation_count);
00053   bool set_trigger_channel (int channel);
00054   bool set_trigger_mode (gr_trigger_mode mode);
00055   bool set_trigger_slope (gr_trigger_slope slope);
00056   bool set_trigger_level (double trigger_level);
00057   bool set_trigger_level_auto ();                               // set to 50% level
00058   bool set_sample_rate(double sample_rate);
00059   bool set_num_channels (int nchannels);
00060
00061
00062   // ACCESSORS
00063   int num_channels () const;
00064   double sample_rate () const;
00065   double update_rate () const;
00066   int get_decimation_count () const;
00067   int get_trigger_channel () const;
00068   gr_trigger_mode get_trigger_mode () const;
00069   gr_trigger_slope get_trigger_slope () const;
00070   double get_trigger_level () const;
00071
00072   // # of samples written to each output record.
00073   int get_samples_per_output_record () const;
00074
00075 };
00076
00077 #endif /* INCLUDED_GR_OSCOPE_SINK_X_H */