<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.3">
<compounddef id="classgr__throttle" kind="class" prot="public">
<compoundname>gr_throttle</compoundname>
<basecompoundref refid="classgr__sync__block" prot="public" virt="non-virtual">gr_sync_block</basecompoundref>
<includes refid="gr__throttle_8h" local="no">gr_throttle.h</includes>
<sectiondef kind="private-attrib">
<memberdef kind="variable" id="classgr__throttle_1a4cf6a25892c2caa08f95ac898b1fc1cb" prot="private" static="no" mutable="no">
<type>size_t</type>
<definition>size_t gr_throttle::d_itemsize</definition>
<argsstring></argsstring>
<name>d_itemsize</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_throttle.h" line="50" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_throttle.h" bodystart="50" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classgr__throttle_1a3686c694fd492c9a35c6d69f6542a980" prot="private" static="no" mutable="no">
<type>double</type>
<definition>double gr_throttle::d_samples_per_sec</definition>
<argsstring></argsstring>
<name>d_samples_per_sec</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_throttle.h" line="51" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_throttle.h" bodystart="51" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classgr__throttle_1ad7a9f370a21aec2219d8f6bd5c5bf8ed" prot="private" static="no" mutable="no">
<type>double</type>
<definition>double gr_throttle::d_total_samples</definition>
<argsstring></argsstring>
<name>d_total_samples</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_throttle.h" line="52" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_throttle.h" bodystart="52" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="friend">
<memberdef kind="friend" id="classgr__throttle_1a863d28356ce4fe780cc43fa9a30ec8a7" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>friend <ref refid="classboost_1_1shared__ptr" kindref="compound">gr_throttle_sptr</ref></type>
<definition>gr_throttle_sptr gr_make_throttle</definition>
<argsstring>(size_t itemsize, double samples_per_sec)</argsstring>
<name>gr_make_throttle</name>
<param>
<type>size_t</type>
<declname>itemsize</declname>
</param>
<param>
<type>double</type>
<declname>samples_per_sec</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_throttle.h" line="49"/>
</memberdef>
</sectiondef>
<sectiondef kind="private-func">
<memberdef kind="function" id="classgr__throttle_1a4eae84e49912c21b62d21166ebd5090c" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>gr_throttle::gr_throttle</definition>
<argsstring>(size_t itemsize, double samples_per_sec)</argsstring>
<name>gr_throttle</name>
<param>
<type>size_t</type>
<declname>itemsize</declname>
</param>
<param>
<type>double</type>
<declname>samples_per_sec</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_throttle.h" line="57"/>
</memberdef>
</sectiondef>
<sectiondef kind="public-func">
<memberdef kind="function" id="classgr__throttle_1a8885c3c6ab6d7a53b348792efb0b3c5e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>gr_throttle::~gr_throttle</definition>
<argsstring>()</argsstring>
<name>~gr_throttle</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_throttle.h" line="60"/>
</memberdef>
<memberdef kind="function" id="classgr__throttle_1a7f01eee4ac1c7d70592118a7f19853ec" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
<type>int</type>
<definition>int gr_throttle::work</definition>
<argsstring>(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)</argsstring>
<name>work</name>
<reimplements refid="classgr__sync__block_1a0c523f4285a6eb690f677ee6295ab117">work</reimplements>
<param>
<type>int</type>
<declname>noutput_items</declname>
</param>
<param>
<type><ref refid="classstd_1_1vector" kindref="compound">gr_vector_const_void_star</ref> &</type>
<declname>input_items</declname>
</param>
<param>
<type><ref refid="classstd_1_1vector" kindref="compound">gr_vector_void_star</ref> &</type>
<declname>output_items</declname>
</param>
<briefdescription>
<para>just like <ref refid="classgr__block_1a137b93d87dc83bbdb6369d33f4ea8197" kindref="member">gr_block::general_work</ref>, only this arranges to call consume_each for you </para> </briefdescription>
<detaileddescription>
<para>The user must override work to define the signal processing code </para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_throttle.h" line="64"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>throttle flow of samples such that the average rate does not exceed samples_per_sec.</para><para>input: one stream of itemsize; output: one stream of itemsize </para> </briefdescription>
<detaileddescription>
<para>N.B. this should only be used in GUI apps where there is no other rate limiting block. It is not intended nor effective at precisely controlling the rate of samples. That should be controlled by a source or sink tied to sample clock. E.g., a USRP or audio card. </para> </detaileddescription>
<inheritancegraph>
<node id="13734">
<label>gr_throttle</label>
<link refid="classgr__throttle"/>
<childnode refid="13735" relation="public-inheritance">
</childnode>
</node>
<node id="13735">
<label>gr_sync_block</label>
<link refid="classgr__sync__block"/>
<childnode refid="13736" relation="public-inheritance">
</childnode>
</node>
<node id="13736">
<label>gr_block</label>
<link refid="classgr__block"/>
<childnode refid="13737" relation="public-inheritance">
</childnode>
</node>
<node id="13737">
<label>gr_basic_block</label>
<link refid="classgr__basic__block"/>
</node>
</inheritancegraph>
<collaborationgraph>
<node id="13755">
<label>std::vector< gr_buffer_reader * ></label>
<link refid="classstd_1_1vector"/>
<childnode refid="13751" relation="usage">
<edgelabel>p</edgelabel>
<edgelabel>elements</edgelabel>
</childnode>
</node>
<node id="13750">
<label>boost::shared_ptr< gr_buffer_reader ></label>
<link refid="classboost_1_1shared__ptr"/>
<childnode refid="13751" relation="usage">
<edgelabel>px</edgelabel>
</childnode>
</node>
<node id="13759">
<label>T</label>
</node>
<node id="13738">
<label>gr_throttle</label>
<link refid="classgr__throttle"/>
<childnode refid="13739" relation="public-inheritance">
</childnode>
</node>
<node id="13739">
<label>gr_sync_block</label>
<link refid="classgr__sync__block"/>
<childnode refid="13740" relation="public-inheritance">
</childnode>
</node>
<node id="13751">
<label>gr_buffer_reader</label>
<link refid="classgr__buffer__reader"/>
<childnode refid="13752" relation="usage">
<edgelabel>d_buffer</edgelabel>
</childnode>
</node>
<node id="13754">
<label>gr_vmcircbuf</label>
<link refid="classgr__vmcircbuf"/>
</node>
<node id="13740">
<label>gr_block</label>
<link refid="classgr__block"/>
<childnode refid="13741" relation="public-inheritance">
</childnode>
<childnode refid="13747" relation="usage">
<edgelabel>d_detail</edgelabel>
</childnode>
</node>
<node id="13747">
<label>boost::shared_ptr< gr_block_detail ></label>
<link refid="classboost_1_1shared__ptr"/>
<childnode refid="13748" relation="usage">
<edgelabel>px</edgelabel>
</childnode>
</node>
<node id="13758">
<label>boost::shared_ptr< T ></label>
<link refid="classboost_1_1shared__ptr"/>
<childnode refid="13759" relation="usage">
<edgelabel>px</edgelabel>
</childnode>
</node>
<node id="13748">
<label>gr_block_detail</label>
<link refid="classgr__block__detail"/>
<childnode refid="13749" relation="usage">
<edgelabel>d_input</edgelabel>
</childnode>
<childnode refid="13756" relation="usage">
<edgelabel>d_tpb</edgelabel>
</childnode>
<childnode refid="13757" relation="usage">
<edgelabel>d_output</edgelabel>
</childnode>
</node>
<node id="13742">
<label>boost::shared_ptr< gr_io_signature ></label>
<link refid="classboost_1_1shared__ptr"/>
<childnode refid="13743" relation="usage">
<edgelabel>px</edgelabel>
</childnode>
</node>
<node id="13753">
<label>gr_buffer</label>
<link refid="classgr__buffer"/>
<childnode refid="13754" relation="usage">
<edgelabel>d_vmcircbuf</edgelabel>
</childnode>
<childnode refid="13755" relation="usage">
<edgelabel>d_readers</edgelabel>
</childnode>
</node>
<node id="13746">
<label>std::basic_string< char ></label>
</node>
<node id="13749">
<label>std::vector< gr_buffer_reader_sptr ></label>
<childnode refid="13750" relation="usage">
<edgelabel>p</edgelabel>
<edgelabel>elements</edgelabel>
</childnode>
</node>
<node id="13752">
<label>boost::shared_ptr< gr_buffer ></label>
<link refid="classboost_1_1shared__ptr"/>
<childnode refid="13753" relation="usage">
<edgelabel>px</edgelabel>
</childnode>
</node>
<node id="13756">
<label>gr_tpb_detail</label>
<link refid="structgr__tpb__detail"/>
</node>
<node id="13757">
<label>std::vector< gr_buffer_sptr ></label>
<childnode refid="13758" relation="usage">
<edgelabel>p</edgelabel>
<edgelabel>elements</edgelabel>
</childnode>
</node>
<node id="13743">
<label>gr_io_signature</label>
<link refid="classgr__io__signature"/>
<childnode refid="13744" relation="usage">
<edgelabel>d_sizeof_stream_item</edgelabel>
</childnode>
</node>
<node id="13741">
<label>gr_basic_block</label>
<link refid="classgr__basic__block"/>
<childnode refid="13742" relation="usage">
<edgelabel>d_input_signature</edgelabel>
<edgelabel>d_output_signature</edgelabel>
</childnode>
<childnode refid="13745" relation="usage">
<edgelabel>d_name</edgelabel>
</childnode>
</node>
<node id="13744">
<label>std::vector< int ></label>
<link refid="classstd_1_1vector"/>
</node>
<node id="13745">
<label>std::string</label>
<childnode refid="13746" relation="public-inheritance">
</childnode>
</node>
</collaborationgraph>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_throttle.h" line="48" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_throttle.h" bodystart="47" bodyend="65"/>
<listofallmembers>
<member refid="classgr__basic__block_1a2503eb6922db0bf2a442dcd2d14670c9" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>basic_block</name></member>
<member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3da0abd1c82699481ffa502e5bb8d7bdaec" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>BLACK</name></member>
<member refid="classgr__basic__block_1a50a714df9c3ce8c03854a09ac84e589b" prot="public" virt="virtual"><scope>gr_throttle</scope><name>check_topology</name></member>
<member refid="classgr__basic__block_1a1cedb1704b6c00977c681b378ede384c" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>color</name></member>
<member refid="classgr__block_1ac76b4c53af762a819bca003d5b5cb4d1" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>consume</name></member>
<member refid="classgr__block_1a64e9a2096975841b72ff3c1662d27df9" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>consume_each</name></member>
<member refid="classgr__basic__block_1a7fb7e692e3b98a82410b396ef263bb41" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>d_color</name></member>
<member refid="classgr__basic__block_1a2c8da0c28bbbfb0e759278c9b9459e96" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>d_input_signature</name></member>
<member refid="classgr__throttle_1a4cf6a25892c2caa08f95ac898b1fc1cb" prot="private" virt="non-virtual"><scope>gr_throttle</scope><name>d_itemsize</name></member>
<member refid="classgr__basic__block_1afd352cc073ef28012d4d079a863f5401" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>d_name</name></member>
<member refid="classgr__basic__block_1a76d64ed7a79566e3310306ae6f194d75" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>d_output_signature</name></member>
<member refid="classgr__throttle_1a3686c694fd492c9a35c6d69f6542a980" prot="private" virt="non-virtual"><scope>gr_throttle</scope><name>d_samples_per_sec</name></member>
<member refid="classgr__throttle_1ad7a9f370a21aec2219d8f6bd5c5bf8ed" prot="private" virt="non-virtual"><scope>gr_throttle</scope><name>d_total_samples</name></member>
<member refid="classgr__basic__block_1a0d2999c04f47327f93dd7def5dc704f8" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>d_unique_id</name></member>
<member refid="classgr__block_1afb276858409ac55d62fca1c87d7d4083" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>detail</name></member>
<member refid="classgr__block_1ab4eeb29440f674815ab3b44b4fb0c34d" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>fixed_rate</name></member>
<member refid="classgr__sync__block_1a0cbbc0ce275498411248e678038710b2" prot="public" virt="virtual"><scope>gr_throttle</scope><name>fixed_rate_ninput_to_noutput</name></member>
<member refid="classgr__sync__block_1adaecb00ae09408c22e46c44d09aad53e" prot="public" virt="virtual"><scope>gr_throttle</scope><name>fixed_rate_noutput_to_ninput</name></member>
<member refid="classgr__sync__block_1a1327e83509baf039aa3c816ea81a8f22" prot="public" virt="virtual"><scope>gr_throttle</scope><name>forecast</name></member>
<member refid="classgr__sync__block_1a56ca60b6bc20a3510f71d961891fa81b" prot="public" virt="virtual"><scope>gr_throttle</scope><name>general_work</name></member>
<member refid="classgr__basic__block_1a1183eee484f58953a2fed4c792e46245" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>gr_basic_block</name></member>
<member refid="classgr__block_1a268510acce1f94c0a60c5273f4948641" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>gr_block</name></member>
<member refid="classgr__basic__block_1a69b41e361328cea911d69e1ec0bc50ff" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>gr_flat_flowgraph</name></member>
<member refid="classgr__basic__block_1adf5bf4523d6dd698aa770e3da8f2b30d" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>gr_flowgraph</name></member>
<member refid="classgr__throttle_1a863d28356ce4fe780cc43fa9a30ec8a7" prot="private" virt="non-virtual"><scope>gr_throttle</scope><name>gr_make_throttle</name></member>
<member refid="classgr__sync__block_1a832d8dad2dbd38e8e9cfa0b954d37c87" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>gr_sync_block</name></member>
<member refid="classgr__throttle_1a4eae84e49912c21b62d21166ebd5090c" prot="private" virt="non-virtual"><scope>gr_throttle</scope><name>gr_throttle</name></member>
<member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3daa6cce7ec34a3f9cf917e545a743dc89f" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>GREY</name></member>
<member refid="classgr__block_1ad3b305a663f4b5b5c4e17070d00f05d9" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>history</name></member>
<member refid="classgr__basic__block_1a58f6d05e85931200f3771d3e50741281" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>input_signature</name></member>
<member refid="classgr__basic__block_1aa12a20d8b8eab341da935530d29299d2" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>name</name></member>
<member refid="classgr__block_1ade8590e9cba9ccfe1b870be46b1416c2" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>output_multiple</name></member>
<member refid="classgr__basic__block_1add68b96f012dfe352700b4fd1c3a184a" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>output_signature</name></member>
<member refid="classgr__block_1aa9df8c4d3fb92bde98900831546f8b97" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>relative_rate</name></member>
<member refid="classgr__basic__block_1a0821ef947158670d53bf0739f3c8877b" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>set_color</name></member>
<member refid="classgr__block_1a26b61f2c2ca308c3bde82f01d3e9650b" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>set_detail</name></member>
<member refid="classgr__block_1a176a95343488a9a760c8edf8bb08db20" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>set_fixed_rate</name></member>
<member refid="classgr__block_1a7c1c85a2d47f72255efd821a6f98f7ba" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>set_history</name></member>
<member refid="classgr__basic__block_1a419d0fbba0ca02d822cbc299b979de54" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>set_input_signature</name></member>
<member refid="classgr__block_1a14e8b799f920e52afb93fac413b1a729" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>set_output_multiple</name></member>
<member refid="classgr__basic__block_1a949b6ad69ebfdf423835265db99cf63d" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>set_output_signature</name></member>
<member refid="classgr__block_1ab9dc7e6d30692bbfa65fc7c4eef6fc9d" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>set_relative_rate</name></member>
<member refid="classgr__block_1a49ea94a86f3199f23563bb837633ea1f" prot="public" virt="virtual"><scope>gr_throttle</scope><name>start</name></member>
<member refid="classgr__block_1a53c2c89c037e4e393b75414d605e36b1" prot="public" virt="virtual"><scope>gr_throttle</scope><name>stop</name></member>
<member refid="classgr__basic__block_1aa2a2947744d418c5470fbf4e623b58fe" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>unique_id</name></member>
<member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3d" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>vcolor</name></member>
<member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3da476d594a077e729bad0f2cfa2008c899" prot="protected" virt="non-virtual"><scope>gr_throttle</scope><name>WHITE</name></member>
<member refid="classgr__throttle_1a7f01eee4ac1c7d70592118a7f19853ec" prot="public" virt="virtual"><scope>gr_throttle</scope><name>work</name></member>
<member refid="classgr__basic__block_1a5bc14d27d53b7b57a960a47cc255e3f9" prot="public" virt="virtual"><scope>gr_throttle</scope><name>~gr_basic_block</name></member>
<member refid="classgr__block_1a19133eeffa5f8e6743342f375551ad0c" prot="public" virt="virtual"><scope>gr_throttle</scope><name>~gr_block</name></member>
<member refid="classgr__throttle_1a8885c3c6ab6d7a53b348792efb0b3c5e" prot="public" virt="non-virtual"><scope>gr_throttle</scope><name>~gr_throttle</name></member>
</listofallmembers>
</compounddef>
</doxygen>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
7820
