GNU Radio 3.5.3.2 C++ API
|
00001 /* -*- c++ -*- */ 00002 /* 00003 * Copyright 2010 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_ANNOTATOR_1TO1_H 00024 #define INCLUDED_GR_ANNOTATOR_1TO1_H 00025 00026 #include <gr_core_api.h> 00027 #include <gr_sync_block.h> 00028 00029 class gr_annotator_1to1; 00030 typedef boost::shared_ptr<gr_annotator_1to1> gr_annotator_1to1_sptr; 00031 00032 // public constructor 00033 GR_CORE_API gr_annotator_1to1_sptr 00034 gr_make_annotator_1to1 (int when, size_t sizeof_stream_item); 00035 00036 /*! 00037 * \brief 1-to-1 stream annotator testing block. FOR TESTING PURPOSES ONLY. 00038 * 00039 * This block creates tags to be sent downstream every 10,000 items it sees. The 00040 * tags contain the name and ID of the instantiated block, use "seq" as a key, 00041 * and have a counter that increments by 1 for every tag produced that is used 00042 * as the tag's value. The tags are propagated using the 1-to-1 policy. 00043 * 00044 * It also stores a copy of all tags it sees flow past it. These tags can be 00045 * recalled externally with the data() member. 00046 * 00047 * This block is only meant for testing and showing how to use the tags. 00048 */ 00049 class GR_CORE_API gr_annotator_1to1 : public gr_sync_block 00050 { 00051 public: 00052 ~gr_annotator_1to1 (); 00053 int work (int noutput_items, 00054 gr_vector_const_void_star &input_items, 00055 gr_vector_void_star &output_items); 00056 00057 std::vector<gr_tag_t> data() const 00058 { 00059 return d_stored_tags; 00060 } 00061 00062 protected: 00063 gr_annotator_1to1 (int when, size_t sizeof_stream_item); 00064 00065 private: 00066 size_t d_itemsize; 00067 uint64_t d_when; 00068 uint64_t d_tag_counter; 00069 std::vector<gr_tag_t> d_stored_tags; 00070 00071 friend GR_CORE_API gr_annotator_1to1_sptr 00072 gr_make_annotator_1to1 (int when, size_t sizeof_stream_item); 00073 }; 00074 00075 #endif