<?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__simple__framer" kind="class" prot="public"> <compoundname>gr_simple_framer</compoundname> <basecompoundref refid="classgr__block" prot="public" virt="non-virtual">gr_block</basecompoundref> <includes refid="gr__simple__framer_8h" local="no">gr_simple_framer.h</includes> <sectiondef kind="private-attrib"> <memberdef kind="variable" id="classgr__simple__framer_1a6ace67aae802f708945316364d4f6b6c" prot="private" static="no" mutable="no"> <type>int</type> <definition>int gr_simple_framer::d_seqno</definition> <argsstring></argsstring> <name>d_seqno</name> <briefdescription> </briefdescription> <detaileddescription> </detaileddescription> <inbodydescription> </inbodydescription> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" line="39" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" bodystart="39" bodyend="-1"/> </memberdef> <memberdef kind="variable" id="classgr__simple__framer_1ac24ad37fed30a17dc707d3cc4b56ddc1" prot="private" static="no" mutable="no"> <type>int</type> <definition>int gr_simple_framer::d_payload_bytesize</definition> <argsstring></argsstring> <name>d_payload_bytesize</name> <briefdescription> </briefdescription> <detaileddescription> </detaileddescription> <inbodydescription> </inbodydescription> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" line="40" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" bodystart="40" bodyend="-1"/> </memberdef> <memberdef kind="variable" id="classgr__simple__framer_1ae2c2c448ba63484df8c51a0dcced0675" prot="private" static="no" mutable="no"> <type>int</type> <definition>int gr_simple_framer::d_input_block_size</definition> <argsstring></argsstring> <name>d_input_block_size</name> <briefdescription> </briefdescription> <detaileddescription> </detaileddescription> <inbodydescription> </inbodydescription> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" line="41" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" bodystart="41" bodyend="-1"/> </memberdef> <memberdef kind="variable" id="classgr__simple__framer_1acc3f1ea0ec4c76be221bae37ff33ae94" prot="private" static="no" mutable="no"> <type>int</type> <definition>int gr_simple_framer::d_output_block_size</definition> <argsstring></argsstring> <name>d_output_block_size</name> <briefdescription> </briefdescription> <detaileddescription> </detaileddescription> <inbodydescription> </inbodydescription> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" line="42" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" bodystart="42" bodyend="-1"/> </memberdef> </sectiondef> <sectiondef kind="friend"> <memberdef kind="friend" id="classgr__simple__framer_1af58deeb3b13d444fadc32299c752a1ac" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> <type>friend <ref refid="classboost_1_1shared__ptr" kindref="compound">gr_simple_framer_sptr</ref></type> <definition>gr_simple_framer_sptr gr_make_simple_framer</definition> <argsstring>(int payload_bytesize)</argsstring> <name>gr_make_simple_framer</name> <param> <type>int</type> <declname>payload_bytesize</declname> </param> <briefdescription> </briefdescription> <detaileddescription> </detaileddescription> <inbodydescription> </inbodydescription> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" line="44"/> </memberdef> </sectiondef> <sectiondef kind="private-func"> <memberdef kind="function" id="classgr__simple__framer_1a0417efe001bb9f593fd825308c5fc7ea" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> <type></type> <definition>gr_simple_framer::gr_simple_framer</definition> <argsstring>(int payload_bytesize)</argsstring> <name>gr_simple_framer</name> <param> <type>int</type> <declname>payload_bytesize</declname> </param> <briefdescription> </briefdescription> <detaileddescription> </detaileddescription> <inbodydescription> </inbodydescription> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" line="45"/> </memberdef> </sectiondef> <sectiondef kind="public-func"> <memberdef kind="function" id="classgr__simple__framer_1a0748fa00c41654ec1f3b6b2a7647555a" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual"> <type>void</type> <definition>void gr_simple_framer::forecast</definition> <argsstring>(int noutput_items, gr_vector_int &ninput_items_required)</argsstring> <name>forecast</name> <reimplements refid="classgr__block_1aa1f2518b5c97126bb015adb9e2027f4a">forecast</reimplements> <param> <type>int</type> <declname>noutput_items</declname> </param> <param> <type><ref refid="classstd_1_1vector" kindref="compound">gr_vector_int</ref> &</type> <declname>ninput_items_required</declname> </param> <briefdescription> <para>Estimate input requirements given output request. </para> </briefdescription> <detaileddescription> <para><parameterlist kind="param"><parameteritem> <parameternamelist> <parametername>noutput_items</parametername> </parameternamelist> <parameterdescription> <para>number of output items to produce </para></parameterdescription> </parameteritem> <parameteritem> <parameternamelist> <parametername>ninput_items_required</parametername> </parameternamelist> <parameterdescription> <para>number of input items required on each input stream</para></parameterdescription> </parameteritem> </parameterlist> Given a request to product <computeroutput>noutput_items</computeroutput>, estimate the number of data items required on each input stream. The estimate doesn't have to be exact, but should be close. </para> </detaileddescription> <inbodydescription> </inbodydescription> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" line="49"/> </memberdef> <memberdef kind="function" id="classgr__simple__framer_1a5cb527b4eb4089610094bc73f07f6907" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual"> <type>int</type> <definition>int gr_simple_framer::general_work</definition> <argsstring>(int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)</argsstring> <name>general_work</name> <reimplements refid="classgr__block_1a137b93d87dc83bbdb6369d33f4ea8197">general_work</reimplements> <param> <type>int</type> <declname>noutput_items</declname> </param> <param> <type><ref refid="classstd_1_1vector" kindref="compound">gr_vector_int</ref> &</type> <declname>ninput_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>compute output items from input items </para> </briefdescription> <detaileddescription> <para><parameterlist kind="param"><parameteritem> <parameternamelist> <parametername>noutput_items</parametername> </parameternamelist> <parameterdescription> <para>number of output items to write on each output stream </para></parameterdescription> </parameteritem> <parameteritem> <parameternamelist> <parametername>ninput_items</parametername> </parameternamelist> <parameterdescription> <para>number of input items available on each input stream </para></parameterdescription> </parameteritem> <parameteritem> <parameternamelist> <parametername>input_items</parametername> </parameternamelist> <parameterdescription> <para>vector of pointers to the input items, one entry per input stream </para></parameterdescription> </parameteritem> <parameteritem> <parameternamelist> <parametername>output_items</parametername> </parameternamelist> <parameterdescription> <para>vector of pointers to the output items, one entry per output stream</para></parameterdescription> </parameteritem> </parameterlist> <simplesect kind="return"><para>number of items actually written to each output stream, or -1 on EOF. It is OK to return a value less than noutput_items. -1 <= return value <= noutput_items</para></simplesect> general_work must call consume or consume_each to indicate how many items were consumed on each input stream. </para> </detaileddescription> <inbodydescription> </inbodydescription> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" line="54"/> </memberdef> </sectiondef> <briefdescription> <para>add sync field, seq number and command field to payload </para> </briefdescription> <detaileddescription> </detaileddescription> <inheritancegraph> <node id="12782"> <label>gr_simple_framer</label> <link refid="classgr__simple__framer"/> <childnode refid="12783" relation="public-inheritance"> </childnode> </node> <node id="12783"> <label>gr_block</label> <link refid="classgr__block"/> <childnode refid="12784" relation="public-inheritance"> </childnode> </node> <node id="12784"> <label>gr_basic_block</label> <link refid="classgr__basic__block"/> </node> </inheritancegraph> <collaborationgraph> <node id="12801"> <label>std::vector< gr_buffer_reader * ></label> <link refid="classstd_1_1vector"/> <childnode refid="12797" relation="usage"> <edgelabel>p</edgelabel> <edgelabel>elements</edgelabel> </childnode> </node> <node id="12796"> <label>boost::shared_ptr< gr_buffer_reader ></label> <link refid="classboost_1_1shared__ptr"/> <childnode refid="12797" relation="usage"> <edgelabel>px</edgelabel> </childnode> </node> <node id="12805"> <label>T</label> </node> <node id="12785"> <label>gr_simple_framer</label> <link refid="classgr__simple__framer"/> <childnode refid="12786" relation="public-inheritance"> </childnode> </node> <node id="12797"> <label>gr_buffer_reader</label> <link refid="classgr__buffer__reader"/> <childnode refid="12798" relation="usage"> <edgelabel>d_buffer</edgelabel> </childnode> </node> <node id="12800"> <label>gr_vmcircbuf</label> <link refid="classgr__vmcircbuf"/> </node> <node id="12786"> <label>gr_block</label> <link refid="classgr__block"/> <childnode refid="12787" relation="public-inheritance"> </childnode> <childnode refid="12793" relation="usage"> <edgelabel>d_detail</edgelabel> </childnode> </node> <node id="12793"> <label>boost::shared_ptr< gr_block_detail ></label> <link refid="classboost_1_1shared__ptr"/> <childnode refid="12794" relation="usage"> <edgelabel>px</edgelabel> </childnode> </node> <node id="12804"> <label>boost::shared_ptr< T ></label> <link refid="classboost_1_1shared__ptr"/> <childnode refid="12805" relation="usage"> <edgelabel>px</edgelabel> </childnode> </node> <node id="12794"> <label>gr_block_detail</label> <link refid="classgr__block__detail"/> <childnode refid="12795" relation="usage"> <edgelabel>d_input</edgelabel> </childnode> <childnode refid="12802" relation="usage"> <edgelabel>d_tpb</edgelabel> </childnode> <childnode refid="12803" relation="usage"> <edgelabel>d_output</edgelabel> </childnode> </node> <node id="12788"> <label>boost::shared_ptr< gr_io_signature ></label> <link refid="classboost_1_1shared__ptr"/> <childnode refid="12789" relation="usage"> <edgelabel>px</edgelabel> </childnode> </node> <node id="12799"> <label>gr_buffer</label> <link refid="classgr__buffer"/> <childnode refid="12800" relation="usage"> <edgelabel>d_vmcircbuf</edgelabel> </childnode> <childnode refid="12801" relation="usage"> <edgelabel>d_readers</edgelabel> </childnode> </node> <node id="12792"> <label>std::basic_string< char ></label> </node> <node id="12795"> <label>std::vector< gr_buffer_reader_sptr ></label> <childnode refid="12796" relation="usage"> <edgelabel>p</edgelabel> <edgelabel>elements</edgelabel> </childnode> </node> <node id="12798"> <label>boost::shared_ptr< gr_buffer ></label> <link refid="classboost_1_1shared__ptr"/> <childnode refid="12799" relation="usage"> <edgelabel>px</edgelabel> </childnode> </node> <node id="12802"> <label>gr_tpb_detail</label> <link refid="structgr__tpb__detail"/> </node> <node id="12803"> <label>std::vector< gr_buffer_sptr ></label> <childnode refid="12804" relation="usage"> <edgelabel>p</edgelabel> <edgelabel>elements</edgelabel> </childnode> </node> <node id="12789"> <label>gr_io_signature</label> <link refid="classgr__io__signature"/> <childnode refid="12790" relation="usage"> <edgelabel>d_sizeof_stream_item</edgelabel> </childnode> </node> <node id="12787"> <label>gr_basic_block</label> <link refid="classgr__basic__block"/> <childnode refid="12788" relation="usage"> <edgelabel>d_input_signature</edgelabel> <edgelabel>d_output_signature</edgelabel> </childnode> <childnode refid="12791" relation="usage"> <edgelabel>d_name</edgelabel> </childnode> </node> <node id="12790"> <label>std::vector< int ></label> <link refid="classstd_1_1vector"/> </node> <node id="12791"> <label>std::string</label> <childnode refid="12792" relation="public-inheritance"> </childnode> </node> </collaborationgraph> <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" line="38" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_framer.h" bodystart="37" bodyend="55"/> <listofallmembers> <member refid="classgr__basic__block_1a2503eb6922db0bf2a442dcd2d14670c9" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>basic_block</name></member> <member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3da0abd1c82699481ffa502e5bb8d7bdaec" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>BLACK</name></member> <member refid="classgr__basic__block_1a50a714df9c3ce8c03854a09ac84e589b" prot="public" virt="virtual"><scope>gr_simple_framer</scope><name>check_topology</name></member> <member refid="classgr__basic__block_1a1cedb1704b6c00977c681b378ede384c" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>color</name></member> <member refid="classgr__block_1ac76b4c53af762a819bca003d5b5cb4d1" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>consume</name></member> <member refid="classgr__block_1a64e9a2096975841b72ff3c1662d27df9" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>consume_each</name></member> <member refid="classgr__basic__block_1a7fb7e692e3b98a82410b396ef263bb41" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>d_color</name></member> <member refid="classgr__simple__framer_1ae2c2c448ba63484df8c51a0dcced0675" prot="private" virt="non-virtual"><scope>gr_simple_framer</scope><name>d_input_block_size</name></member> <member refid="classgr__basic__block_1a2c8da0c28bbbfb0e759278c9b9459e96" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>d_input_signature</name></member> <member refid="classgr__basic__block_1afd352cc073ef28012d4d079a863f5401" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>d_name</name></member> <member refid="classgr__simple__framer_1acc3f1ea0ec4c76be221bae37ff33ae94" prot="private" virt="non-virtual"><scope>gr_simple_framer</scope><name>d_output_block_size</name></member> <member refid="classgr__basic__block_1a76d64ed7a79566e3310306ae6f194d75" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>d_output_signature</name></member> <member refid="classgr__simple__framer_1ac24ad37fed30a17dc707d3cc4b56ddc1" prot="private" virt="non-virtual"><scope>gr_simple_framer</scope><name>d_payload_bytesize</name></member> <member refid="classgr__simple__framer_1a6ace67aae802f708945316364d4f6b6c" prot="private" virt="non-virtual"><scope>gr_simple_framer</scope><name>d_seqno</name></member> <member refid="classgr__basic__block_1a0d2999c04f47327f93dd7def5dc704f8" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>d_unique_id</name></member> <member refid="classgr__block_1afb276858409ac55d62fca1c87d7d4083" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>detail</name></member> <member refid="classgr__block_1ab4eeb29440f674815ab3b44b4fb0c34d" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>fixed_rate</name></member> <member refid="classgr__block_1a4f17bec4407904b31d45f0d8e78c4683" prot="public" virt="virtual"><scope>gr_simple_framer</scope><name>fixed_rate_ninput_to_noutput</name></member> <member refid="classgr__block_1a196ae6a4f9a3d0abed3428d2b765a133" prot="public" virt="virtual"><scope>gr_simple_framer</scope><name>fixed_rate_noutput_to_ninput</name></member> <member refid="classgr__simple__framer_1a0748fa00c41654ec1f3b6b2a7647555a" prot="public" virt="virtual"><scope>gr_simple_framer</scope><name>forecast</name></member> <member refid="classgr__simple__framer_1a5cb527b4eb4089610094bc73f07f6907" prot="public" virt="virtual"><scope>gr_simple_framer</scope><name>general_work</name></member> <member refid="classgr__basic__block_1a1183eee484f58953a2fed4c792e46245" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>gr_basic_block</name></member> <member refid="classgr__block_1a268510acce1f94c0a60c5273f4948641" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>gr_block</name></member> <member refid="classgr__basic__block_1a69b41e361328cea911d69e1ec0bc50ff" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>gr_flat_flowgraph</name></member> <member refid="classgr__basic__block_1adf5bf4523d6dd698aa770e3da8f2b30d" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>gr_flowgraph</name></member> <member refid="classgr__simple__framer_1af58deeb3b13d444fadc32299c752a1ac" prot="private" virt="non-virtual"><scope>gr_simple_framer</scope><name>gr_make_simple_framer</name></member> <member refid="classgr__simple__framer_1a0417efe001bb9f593fd825308c5fc7ea" prot="private" virt="non-virtual"><scope>gr_simple_framer</scope><name>gr_simple_framer</name></member> <member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3daa6cce7ec34a3f9cf917e545a743dc89f" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>GREY</name></member> <member refid="classgr__block_1ad3b305a663f4b5b5c4e17070d00f05d9" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>history</name></member> <member refid="classgr__basic__block_1a58f6d05e85931200f3771d3e50741281" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>input_signature</name></member> <member refid="classgr__basic__block_1aa12a20d8b8eab341da935530d29299d2" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>name</name></member> <member refid="classgr__block_1ade8590e9cba9ccfe1b870be46b1416c2" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>output_multiple</name></member> <member refid="classgr__basic__block_1add68b96f012dfe352700b4fd1c3a184a" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>output_signature</name></member> <member refid="classgr__block_1aa9df8c4d3fb92bde98900831546f8b97" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>relative_rate</name></member> <member refid="classgr__basic__block_1a0821ef947158670d53bf0739f3c8877b" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>set_color</name></member> <member refid="classgr__block_1a26b61f2c2ca308c3bde82f01d3e9650b" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>set_detail</name></member> <member refid="classgr__block_1a176a95343488a9a760c8edf8bb08db20" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>set_fixed_rate</name></member> <member refid="classgr__block_1a7c1c85a2d47f72255efd821a6f98f7ba" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>set_history</name></member> <member refid="classgr__basic__block_1a419d0fbba0ca02d822cbc299b979de54" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>set_input_signature</name></member> <member refid="classgr__block_1a14e8b799f920e52afb93fac413b1a729" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>set_output_multiple</name></member> <member refid="classgr__basic__block_1a949b6ad69ebfdf423835265db99cf63d" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>set_output_signature</name></member> <member refid="classgr__block_1ab9dc7e6d30692bbfa65fc7c4eef6fc9d" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>set_relative_rate</name></member> <member refid="classgr__block_1a49ea94a86f3199f23563bb837633ea1f" prot="public" virt="virtual"><scope>gr_simple_framer</scope><name>start</name></member> <member refid="classgr__block_1a53c2c89c037e4e393b75414d605e36b1" prot="public" virt="virtual"><scope>gr_simple_framer</scope><name>stop</name></member> <member refid="classgr__basic__block_1aa2a2947744d418c5470fbf4e623b58fe" prot="public" virt="non-virtual"><scope>gr_simple_framer</scope><name>unique_id</name></member> <member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3d" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>vcolor</name></member> <member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3da476d594a077e729bad0f2cfa2008c899" prot="protected" virt="non-virtual"><scope>gr_simple_framer</scope><name>WHITE</name></member> <member refid="classgr__basic__block_1a5bc14d27d53b7b57a960a47cc255e3f9" prot="public" virt="virtual"><scope>gr_simple_framer</scope><name>~gr_basic_block</name></member> <member refid="classgr__block_1a19133eeffa5f8e6743342f375551ad0c" prot="public" virt="virtual"><scope>gr_simple_framer</scope><name>~gr_block</name></member> </listofallmembers> </compounddef> </doxygen>