diff options
Diffstat (limited to 'docs/sphinx/source')
24 files changed, 627 insertions, 70 deletions
diff --git a/docs/sphinx/source/analog/get_blocks.py b/docs/sphinx/source/analog/get_blocks.py new file mode 100644 index 0000000000..a288393132 --- /dev/null +++ b/docs/sphinx/source/analog/get_blocks.py @@ -0,0 +1,106 @@ +""" +This script regenerates the gnuradio.blocks sphinx source code. +""" + +from gnuradio import analog +import sys +import os + +doxyxml_location = os.path.abspath("../../../doxygen") +xml_location = os.path.abspath("../../../../build/docs/doxygen/xml/") +sys.path.append(doxyxml_location) + +from doxyxml import DoxyIndex, DoxyClass, DoxyFriend, DoxyFunction, DoxyFile, DoxyGroup +from doxyxml import DoxyOther, base + +class Block(object): + """ + Checks if doxyxml produced objects correspond to a new style + gnuradio block. + """ + + @classmethod + def includes(cls, item): + if not isinstance(item, DoxyClass): + return False + # Check for a parsing error. + if item.error(): + return False + is_a_block = item.has_member('make', DoxyFunction) and item.has_member('sptr', DoxyOther) + return is_a_block + +class Group(object): + """ + Checks if doxyxml produced objects correspond to a group. + """ + + @classmethod + def includes(cls, item): + if not isinstance(item, DoxyGroup): + return False + # Check for a parsing error. + if item.error(): + return False + return True + +def main(): + di = DoxyIndex(xml_location) + blocks = di.in_category(Block) + analog_blocks = [] + for block in blocks: + if block.name().startswith("gr::analog::"): + analog_blocks.append(block) + + all_grouped_blocks = [] + groups = di.in_category(Group) + groupinfo = [] + for group in groups: + contains_analog_blocks = False + block_list = [] + members = group.members() + for member in members: + if member.name().startswith("gr::analog"): + all_grouped_blocks.append(member) + if not contains_analog_blocks: + contains_analog_blocks = True + groupinfo.append((group.name(), group.title, block_list)) + block_list.append(member) + + for block in analog_blocks: + if block not in all_grouped_blocks: + print("Didn't find block {0}".format(block.name())) + + blockindex = ["""gnuradio.analog +=============== + +.. automodule:: gnuradio.analog"""] + for groupname, grouptitle, blocks in groupinfo: + blockindex.append("") + blockindex.append(grouptitle) + blockindex.append('-'*len(grouptitle)) + blockindex.append(""" +.. autosummary:: + :nosignatures: +""") + for block in blocks: + blockindex.append(" gnuradio.analog.{0}".format( + block.name()[len("gr::analog::"):])) + grouppage = [] + title = "gnuradio.analog: {0}".format(grouptitle) + grouppage.append(title) + grouppage.append('='*len(title)) + grouppage.append('') + for block in blocks: + shortname = block.name()[len("gr::analog::"):] + grouppage.append(".. autoblock:: gnuradio.analog.{0}".format(shortname)) + text = '\n'.join(grouppage) + f = open("{0}.rst".format(groupname), 'w') + f.write(text) + f.close() + text = "\n".join(blockindex) + f = open("index.rst", 'w') + f.write(text) + f.close() + +if __name__ == '__main__': + main() diff --git a/docs/sphinx/source/analog/index.rst b/docs/sphinx/source/analog/index.rst new file mode 100644 index 0000000000..668247cab3 --- /dev/null +++ b/docs/sphinx/source/analog/index.rst @@ -0,0 +1,61 @@ +gnuradio.analog +=============== + +.. automodule:: gnuradio.analog + +Level Controllers +----------------- + +.. autosummary:: + :nosignatures: + + gnuradio.analog.agc_cc + gnuradio.analog.agc2_cc + gnuradio.analog.agc2_ff + gnuradio.analog.agc_ff + gnuradio.analog.ctcss_squelch_ff + gnuradio.analog.feedforward_agc_cc + gnuradio.analog.pwr_squelch_cc + gnuradio.analog.pwr_squelch_ff + gnuradio.analog.rail_ff + gnuradio.analog.simple_squelch_cc + +Measurement Tools +----------------- + +.. autosummary:: + :nosignatures: + + gnuradio.analog.probe_avg_mag_sqrd_c + gnuradio.analog.probe_avg_mag_sqrd_cf + gnuradio.analog.probe_avg_mag_sqrd_f + +Modulators and Demodulators +--------------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.analog.cpfsk_bc + gnuradio.analog.fmdet_cf + gnuradio.analog.frequency_modulator_fc + gnuradio.analog.phase_modulator_fc + gnuradio.analog.quadrature_demod_cf + +Peak Detectors +-------------- + +.. autosummary:: + :nosignatures: + + gnuradio.analog.dpll_bb + +Synchronizers +------------- + +.. autosummary:: + :nosignatures: + + gnuradio.analog.pll_carriertracking_cc + gnuradio.analog.pll_freqdet_cf + gnuradio.analog.pll_refout_cc diff --git a/docs/sphinx/source/analog/level_controllers_blk.rst b/docs/sphinx/source/analog/level_controllers_blk.rst new file mode 100644 index 0000000000..738535d207 --- /dev/null +++ b/docs/sphinx/source/analog/level_controllers_blk.rst @@ -0,0 +1,13 @@ +gnuradio.analog: Level Controllers +================================== + +.. autoblock:: gnuradio.analog.agc_cc +.. autoblock:: gnuradio.analog.agc2_cc +.. autoblock:: gnuradio.analog.agc2_ff +.. autoblock:: gnuradio.analog.agc_ff +.. autoblock:: gnuradio.analog.ctcss_squelch_ff +.. autoblock:: gnuradio.analog.feedforward_agc_cc +.. autoblock:: gnuradio.analog.pwr_squelch_cc +.. autoblock:: gnuradio.analog.pwr_squelch_ff +.. autoblock:: gnuradio.analog.rail_ff +.. autoblock:: gnuradio.analog.simple_squelch_cc diff --git a/docs/sphinx/source/analog/measurement_tools_blk.rst b/docs/sphinx/source/analog/measurement_tools_blk.rst new file mode 100644 index 0000000000..be9accc7e5 --- /dev/null +++ b/docs/sphinx/source/analog/measurement_tools_blk.rst @@ -0,0 +1,6 @@ +gnuradio.analog: Measurement Tools +================================== + +.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_c +.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_cf +.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_f
\ No newline at end of file diff --git a/docs/sphinx/source/analog/modulators_blk.rst b/docs/sphinx/source/analog/modulators_blk.rst new file mode 100644 index 0000000000..3e9f279271 --- /dev/null +++ b/docs/sphinx/source/analog/modulators_blk.rst @@ -0,0 +1,8 @@ +gnuradio.analog: Modulators and Demodulators +============================================ + +.. autoblock:: gnuradio.analog.cpfsk_bc +.. autoblock:: gnuradio.analog.fmdet_cf +.. autoblock:: gnuradio.analog.frequency_modulator_fc +.. autoblock:: gnuradio.analog.phase_modulator_fc +.. autoblock:: gnuradio.analog.quadrature_demod_cf diff --git a/docs/sphinx/source/analog/peak_detectors_blk.rst b/docs/sphinx/source/analog/peak_detectors_blk.rst new file mode 100644 index 0000000000..3105202c2a --- /dev/null +++ b/docs/sphinx/source/analog/peak_detectors_blk.rst @@ -0,0 +1,4 @@ +gnuradio.analog: Peak Detectors +=============================== + +.. autoblock:: gnuradio.analog.dpll_bb
\ No newline at end of file diff --git a/docs/sphinx/source/analog/synchronizers_blk.rst b/docs/sphinx/source/analog/synchronizers_blk.rst new file mode 100644 index 0000000000..938b24ad61 --- /dev/null +++ b/docs/sphinx/source/analog/synchronizers_blk.rst @@ -0,0 +1,6 @@ +gnuradio.analog: Synchronizers +============================== + +.. autoblock:: gnuradio.analog.pll_carriertracking_cc +.. autoblock:: gnuradio.analog.pll_freqdet_cf +.. autoblock:: gnuradio.analog.pll_refout_cc
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/index.rst b/docs/sphinx/source/blocks/index.rst index 2e29a5012a..f89c9c5df5 100644 --- a/docs/sphinx/source/blocks/index.rst +++ b/docs/sphinx/source/blocks/index.rst @@ -185,10 +185,14 @@ Measurement Tools gnuradio.blocks.probe_signal_vi gnuradio.blocks.probe_signal_vs gnuradio.blocks.ctrlport_probe2_c + :noindex: gnuradio.blocks.ctrlport_probe_c + :noindex: gnuradio.blocks.message_debug + :noindex: gnuradio.blocks.probe_rate gnuradio.blocks.tag_debug + :noindex: Message Tools ------------- @@ -198,11 +202,13 @@ Message Tools gnuradio.blocks.message_burst_source gnuradio.blocks.message_debug + :noindex: gnuradio.blocks.message_sink gnuradio.blocks.message_source gnuradio.blocks.message_strobe gnuradio.blocks.pdu_to_tagged_stream gnuradio.blocks.random_pdu + :noindex: gnuradio.blocks.tagged_stream_to_pdu Miscellaneous @@ -236,7 +242,7 @@ Modulators and Demodulators gnuradio.blocks.vco_f -Netwroking Tools +Networking Tools ---------------- .. autosummary:: @@ -260,8 +266,8 @@ Peak Detectors gnuradio.blocks.peak_detector2_fb gnuradio.blocks.plateau_detector_fb -Streams Operators ------------------ +Stream Operators +---------------- .. autosummary:: :nosignatures: @@ -297,8 +303,11 @@ Stream Tag Tools :nosignatures: gnuradio.blocks.burst_tagger + :noindex: gnuradio.blocks.tag_debug + :noindex: gnuradio.blocks.tagged_file_sink + :noindex: Data Type Converters -------------------- @@ -326,19 +335,3 @@ Data Type Converters gnuradio.blocks.short_to_float gnuradio.blocks.uchar_to_float -Waveform Generators -------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.vco_f - -Miscellaneous -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.lfsr_15_1_0 - gnuradio.blocks.lfsr_32k
\ No newline at end of file diff --git a/docs/sphinx/source/channels.rst b/docs/sphinx/source/channels.rst new file mode 100644 index 0000000000..4013b57938 --- /dev/null +++ b/docs/sphinx/source/channels.rst @@ -0,0 +1,8 @@ +gnuradio.channels +================= + +.. automodule:: gnuradio.channels + +.. autoblock:: gnuradio.channels.channel_model +.. autoblock:: gnuradio.channels.fading_model + diff --git a/docs/sphinx/source/comedi.rst b/docs/sphinx/source/comedi.rst new file mode 100644 index 0000000000..2bed3683a2 --- /dev/null +++ b/docs/sphinx/source/comedi.rst @@ -0,0 +1,8 @@ +gnuradio.comedi +=============== + +.. automodule:: gnuradio.comedi + +.. autoblock:: gnuradio.comedi.source_s +.. autoblock:: gnuradio.comedi.sink_s + diff --git a/docs/sphinx/source/fcd.rst b/docs/sphinx/source/fcd.rst new file mode 100644 index 0000000000..126ef9c916 --- /dev/null +++ b/docs/sphinx/source/fcd.rst @@ -0,0 +1,7 @@ +gnuradio.fcd +============ + +.. automodule:: gnuradio.fcd + +.. autoblock:: gnuradio.fcd.fcd_source_c + diff --git a/docs/sphinx/source/fec.rst b/docs/sphinx/source/fec.rst new file mode 100644 index 0000000000..75de71911b --- /dev/null +++ b/docs/sphinx/source/fec.rst @@ -0,0 +1,8 @@ +gnuradio.fec +============ + +.. automodule:: gnuradio.fec + +.. autoblock:: gnuradio.fec.decode_ccsds_27_fb +.. autoblock:: gnuradio.fec.encode_ccsds_27_bb + diff --git a/docs/sphinx/source/filter/channelizers_blk.rst b/docs/sphinx/source/filter/channelizers_blk.rst new file mode 100644 index 0000000000..920be42882 --- /dev/null +++ b/docs/sphinx/source/filter/channelizers_blk.rst @@ -0,0 +1,7 @@ +gnuradio.filter: Channelizers +============================= + +.. autoblock:: gnuradio.filter.pfb_channelizer_ccf +.. autoblock:: gnuradio.filter.pfb_decimator_ccf +.. autoblock:: gnuradio.filter.pfb_interpolator_ccf +.. autoblock:: gnuradio.filter.pfb_synthesizer_ccf
\ No newline at end of file diff --git a/docs/sphinx/source/filter/filter_blk.rst b/docs/sphinx/source/filter/filter_blk.rst new file mode 100644 index 0000000000..5c85c6d00a --- /dev/null +++ b/docs/sphinx/source/filter/filter_blk.rst @@ -0,0 +1,16 @@ +gnuradio.filter: Filters +======================== + +.. autoblock:: gnuradio.filter.adaptive_fir_ccc +.. autoblock:: gnuradio.filter.adaptive_fir_ccf +.. autoblock:: gnuradio.filter.dc_blocker_cc +.. autoblock:: gnuradio.filter.dc_blocker_ff +.. autoblock:: gnuradio.filter.fft_filter_fff +.. autoblock:: gnuradio.filter.fft_filter_ccc +.. autoblock:: gnuradio.filter.filter_delay_fc +.. autoblock:: gnuradio.filter.hilbert_fc +.. autoblock:: gnuradio.filter.iir_filter_ffd +.. autopyblock:: gnuradio.filter.analysis_filterbank +.. autopyblock:: gnuradio.filter.synthesis_filterbank +.. autoblock:: gnuradio.filter.single_pole_iir_filter_cc +.. autoblock:: gnuradio.filter.single_pole_iir_filter_ff diff --git a/docs/sphinx/source/filter/filter_design.rst b/docs/sphinx/source/filter/filter_design.rst new file mode 100644 index 0000000000..4a78156c5d --- /dev/null +++ b/docs/sphinx/source/filter/filter_design.rst @@ -0,0 +1,4 @@ +gnuradio.filter: Digital Filter Design +====================================== + +.. autoclass:: gnuradio.filter.firdes diff --git a/docs/sphinx/source/filter/index.rst b/docs/sphinx/source/filter/index.rst new file mode 100644 index 0000000000..2f1be277ad --- /dev/null +++ b/docs/sphinx/source/filter/index.rst @@ -0,0 +1,56 @@ +gnuradio.filter +=============== + +.. automodule:: gnuradio.filter + +Channelizers +------------ + +.. autosummary:: + :nosignatures: + + gnuradio.filter.pfb_channelizer_ccf + gnuradio.filter.pfb_decimator_ccf + gnuradio.filter.pfb_interpolator_ccf + gnuradio.filter.pfb_synthesizer_ccf + +Filters +------- + +.. autosummary:: + :nosignatures: + + gnuradio.filter.adaptive_fir_ccc + gnuradio.filter.adaptive_fir_ccf + gnuradio.filter.dc_blocker_cc + gnuradio.filter.dc_blocker_ff + gnuradio.filter.fft_filter_fff + gnuradio.filter.fft_filter_ccc + gnuradio.filter.filter_delay_fc + gnuradio.filter.hilbert_fc + gnuradio.filter.iir_filter_ffd + gnuradio.filter.analysis_filterbank + gnuradio.filter.synthesis_filterbank + gnuradio.filter.single_pole_iir_filter_cc + gnuradio.filter.single_pole_iir_filter_ff + +Resamplers +---------- + +.. autosummary:: + :nosignatures: + + gnuradio.filter.fractional_interpolator_cc + gnuradio.filter.fractional_interpolator_ff + gnuradio.filter.fractional_resampler_cc + gnuradio.filter.fractional_resampler_ff + gnuradio.filter.pfb_arb_resampler_ccf + gnuradio.filter.pfb_arb_resampler_fff + +Digital Filter Design +--------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.filter.firdes diff --git a/docs/sphinx/source/filter/resamplers_blk.rst b/docs/sphinx/source/filter/resamplers_blk.rst new file mode 100644 index 0000000000..348888659d --- /dev/null +++ b/docs/sphinx/source/filter/resamplers_blk.rst @@ -0,0 +1,9 @@ +gnuradio.filter: Resamplers +=========================== + +.. autoblock:: gnuradio.filter.fractional_interpolator_cc +.. autoblock:: gnuradio.filter.fractional_interpolator_ff +.. autoblock:: gnuradio.filter.fractional_resampler_cc +.. autoblock:: gnuradio.filter.fractional_resampler_ff +.. autoblock:: gnuradio.filter.pfb_arb_resampler_ccf +.. autoblock:: gnuradio.filter.pfb_arb_resampler_fff
\ No newline at end of file diff --git a/docs/sphinx/source/gr/misc.rst b/docs/sphinx/source/gr/contents.rst index 013f3fc53d..a999a73ea8 100644 --- a/docs/sphinx/source/gr/misc.rst +++ b/docs/sphinx/source/gr/contents.rst @@ -1,11 +1,18 @@ -gnuradio.gr: Miscellaneous -========================== +gnuradio.gr +=========== -.. autofunction:: gnuradio.gr.feval_dd -.. autofunction:: gnuradio.gr.feval_cc -.. autofunction:: gnuradio.gr.feval_ll -.. autofunction:: gnuradio.gr.feval +.. autoclass:: gnuradio.gr.top_block +.. autoclass:: gnuradio.gr.hier_block2 +.. autofunction:: gnuradio.gr.block_detail +.. autofunction:: gnuradio.gr.buffer +.. autofunction:: gnuradio.gr.dispatcher +.. autofunction:: gnuradio.gr.single_threaded_scheduler .. autofunction:: gnuradio.gr.prefs .. autofunction:: gnuradio.gr.message .. autofunction:: gnuradio.gr.msg_queue .. autofunction:: gnuradio.gr.enable_realtime_scheduling +.. autofunction:: gnuradio.gr.feval_dd +.. autofunction:: gnuradio.gr.feval_cc +.. autofunction:: gnuradio.gr.feval_ll +.. autofunction:: gnuradio.gr.feval + diff --git a/docs/sphinx/source/gr/index.rst b/docs/sphinx/source/gr/index.rst index cef9d560e2..7df7114340 100644 --- a/docs/sphinx/source/gr/index.rst +++ b/docs/sphinx/source/gr/index.rst @@ -3,41 +3,21 @@ gnuradio.gr .. automodule:: gnuradio.gr -Signal Processing Blocks ------------------------- - -Top Block and Hierarchical Block Base Classes -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. autosummary:: :nosignatures: gnuradio.gr.top_block gnuradio.gr.hier_block2 - -Miscellaneous -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.gr.feval_dd - gnuradio.gr.feval_cc - gnuradio.gr.feval_ll - gnuradio.gr.feval - gnuradio.gr.prefs - gnuradio.gr.message - gnuradio.gr.msg_queue - gnuradio.gr.enable_realtime_scheduling - -Implementation Details ----------------------- - -.. autosummary:: - :nosignatures: - gnuradio.gr.block_detail gnuradio.gr.buffer gnuradio.gr.dispatcher gnuradio.gr.single_threaded_scheduler + gnuradio.gr.prefs + gnuradio.gr.message + gnuradio.gr.msg_queue + gnuradio.gr.enable_realtime_scheduling + gnuradio.gr.feval_dd + gnuradio.gr.feval_cc + gnuradio.gr.feval_ll + gnuradio.gr.feval diff --git a/docs/sphinx/source/gr/internal.rst b/docs/sphinx/source/gr/internal.rst deleted file mode 100644 index 4948b38d4d..0000000000 --- a/docs/sphinx/source/gr/internal.rst +++ /dev/null @@ -1,7 +0,0 @@ -gnuradio.gr: Implementation Details -=================================== - -.. autofunction:: gnuradio.gr.block_detail -.. autofunction:: gnuradio.gr.buffer -.. autofunction:: gnuradio.gr.dispatcher -.. autofunction:: gnuradio.gr.single_threaded_scheduler diff --git a/docs/sphinx/source/gr/top_block.rst b/docs/sphinx/source/gr/top_block.rst deleted file mode 100644 index 3d4e9ef3d6..0000000000 --- a/docs/sphinx/source/gr/top_block.rst +++ /dev/null @@ -1,7 +0,0 @@ -gnuradio.gr: Top Block and Hierarchical Block Base Classes -========================================================== - -.. autoclass:: gnuradio.gr.top_block - -.. autoclass:: gnuradio.gr.hier_block2 - diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index be8cc27b95..ceafe7e80e 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -10,9 +10,15 @@ Core Framework :nosignatures: gnuradio.gr + pmt gnuradio.blocks + gnuradio.analog gnuradio.digital gnuradio.audio + gnuradio.channels + gnuradio.comedi + gnuradio.fec + gnuradio.filter gnuradio.trellis gnuradio.wavelet gnuradio.fft @@ -24,9 +30,15 @@ Core Framework :hidden: gnuradio.gr <gr/index> + pmt <pmt/index> gnuradio.blocks <blocks/index> + gnuradio.analog <analog/index> gnuradio.digital <digital/index> gnuradio.audio <audio/index> + gnuradio.channels <channels> + gnuradio.comedi <comedi> + gnuradio.fec <fec> + gnuradio.filter <filter/index> gnuradio.gr_unittest <gr_unittest/index> gnuradio.trellis <trellis/index> gnuradio.wavelet <wavelet> @@ -41,11 +53,15 @@ Hardware Interfaces :nosignatures: gnuradio.uhd + gnuradio.fcd + gnuradio.shd .. toctree:: :hidden: gnuradio.uhd <uhd> + gnuradio.fcd <fcd> + gnuradio.shd <shd> Utilities --------- @@ -92,9 +108,7 @@ Framework Extensions .. toctree:: :hidden: - internal <gr/internal> - top_block <gr/top_block> - misc <gr/misc> + runtime_contents <gr/contents> atsc_blks <atsc/blks> digital_blocks <digital/blocks> constellations <digital/constellations> @@ -126,3 +140,13 @@ Framework Extensions blocks_message <blocks/message_tools_blk> blocks_waveform <blocks/waveform_generators_blk> blocks_misc <blocks/misc_blk> + analog_level_controllers <analog/level_controllers_blk> + analog_peak_detectors <analog/peak_detectors_blk> + analog_measurement <analog/measurement_tools_blk> + analog_synchronizers <analog/synchronizers_blk> + analog_modulators <analog/modulators_blk> + filter_channelizers <filter/channelizers_blk> + filter_resamplers <filter/resamplers_blk> + filter_blocks <filter/filter_blk> + filter_design <filter/filter_design> + diff --git a/docs/sphinx/source/pmt/index.rst b/docs/sphinx/source/pmt/index.rst new file mode 100644 index 0000000000..2411f626e4 --- /dev/null +++ b/docs/sphinx/source/pmt/index.rst @@ -0,0 +1,232 @@ +pmt +=== + +.. automodule:: pmt + +Contants +-------- + +.. autosummary:: + :nosignatures: + + pmt.PMT_EOF + pmt.PMT_EOF + pmt.PMT_F + pmt.PMT_NIL + pmt.PMT_T + +Vector +------ + +.. autosummary:: + :nosignatures: + + pmt.c32vector_elements + pmt.c64vector_elements + pmt.f32vector_elements + pmt.f64vector_elements + pmt.s16vector_elements + pmt.s32vector_elements + pmt.s8vector_elements + pmt.u16vector_elements + pmt.u32vector_elements + pmt.u8vector_elements + pmt.uniform_vector_elements + + pmt.c32vector_ref + pmt.c64vector_ref + pmt.f32vector_ref + pmt.f64vector_ref + pmt.s16vector_ref + pmt.s32vector_ref + pmt.s64vector_ref + pmt.s8vector_ref + pmt.u16vector_ref + pmt.u32vector_ref + pmt.u64vector_ref + pmt.u8vector_ref + pmt.vector_ref + + pmt.c32vector_set + pmt.c64vector_set + pmt.f32vector_set + pmt.f64vector_set + pmt.s16vector_set + pmt.s32vector_set + pmt.s64vector_set + pmt.s8vector_set + pmt.u16vector_set + pmt.u32vector_set + pmt.u64vector_set + pmt.u8vector_set + pmt.vector_set + + pmt.gr_vector_complexd + pmt.gr_vector_complexf + pmt.gr_vector_vector_complexd + pmt.gr_vector_vector_complexf + + pmt.init_c32vector + pmt.init_c64vector + pmt.init_f32vector + pmt.init_f64vector + pmt.init_s16vector + pmt.init_s32vector + pmt.init_s8vector + pmt.init_u16vector + pmt.init_u32vector + pmt.init_u8vector + + pmt.make_c32vector + pmt.make_c64vector + pmt.make_f32vector + pmt.make_f64vector + pmt.make_s16vector + pmt.make_s32vector + pmt.make_s64vector + pmt.make_s8vector + pmt.make_u16vector + pmt.make_u32vector + pmt.make_u64vector + pmt.make_u8vector + pmt.make_vector + + pmt.vector_fill + +Dictionary +---------- + +.. autosummary:: + :nosignatures: + + pmt.dict_add + pmt.dict_delete + pmt.dict_has_key + pmt.dict_items + pmt.dict_keys + pmt.dict_ref + pmt.dict_values + pmt.make_dict + +Unused +------ + +.. autosummary:: + :nosignatures: + + pmt.acons + pmt.any_ref + pmt.any_set + pmt_assoc + pmt.assq + pmt.assv + pmt.blob_data + pmt.blob_length + pmt.caar + pmt.cadddr + pmt.caddr + pmt.cadr + pmt.car + pmt.cdar + pmt.cddr + pmt.cdr + pmt.cons + pmt.cvar + pmt.deserialize + pmt.deserialize_str + pmt.dump_sizeof + pmt.eq + pmt.equal + pmt.eqv + pmt.from_bool + pmt.from_complex + pmt.from_double + pmt.from_long + pmt.from_uint64 + pmt.intern + pmt.list1 + pmt.list2 + pmt.list3 + pmt.list4 + pmt.list5 + pmt.list6 + pmt.list_add + pmt.list_has + pmt.list_rm + pmt.make_any + pmt.make_blob + pmt.make_msg_accepter + pmt.make_rectangular + pmt.make_tuple + pmt.map + pmt.member + pmt.memq + pmt.memv + pmt.msg_accepter_ref + pmt.nth + pmt.nthcdr + pmt.pmt_swig + pmt.pmt_to_python + pmt.read + pmt.reverse + pmt.reverse_x + pmt.serialize + pmt.serialize_str + pmt.set_car + pmt.set_cdr + pmt.string_to_symbol + pmt.subsetp + pmt.swig_int_ptr + pmt.swig_int_ptr_swigregister + pmt.symbol_to_string + pmt.to_bool + pmt.to_complex + pmt.to_double + pmt.to_long + pmt.to_pmt + pmt.to_python + pmt.to_tuple + pmt.to_uint64 + pmt.tuple_ref + pmt.write + pmt.write_string + +Check PMT Type +-------------- + +.. autosummary:: + :nosignatures: + + pmt.is_any + pmt.is_blob + pmt.is_bool + pmt.is_c32vector + pmt.is_c64vector + pmt.is_complex + pmt.is_dict + pmt.is_eof_object + pmt.is_f32vector + pmt.is_f64vector + pmt.is_false + pmt.is_integer + pmt.is_msg_accepter + pmt.is_null + pmt.is_number + pmt.is_pair + pmt.is_real + pmt.is_s16vector + pmt.is_s32vector + pmt.is_s64vector + pmt.is_s8vector + pmt.is_symbol + pmt.is_true + pmt.is_tuple + pmt.is_u16vector + pmt.is_u32vector + pmt.is_u64vector + pmt.is_u8vector + pmt.is_uint64 + pmt.is_uniform_vector + pmt.is_vector + pmt.length + diff --git a/docs/sphinx/source/shd.rst b/docs/sphinx/source/shd.rst new file mode 100644 index 0000000000..6661ceb9b1 --- /dev/null +++ b/docs/sphinx/source/shd.rst @@ -0,0 +1,8 @@ +gnuradio.shd +============ + +.. automodule:: gnuradio.shd + +.. autoblock:: gnuradio.shd.shd_smini_sink +.. autoblock:: gnuradio.shd.shd_smini_source + |