diff options
Diffstat (limited to 'docs/doxygen/other')
| -rw-r--r-- | docs/doxygen/other/pmt.dox | 17 | ||||
| -rw-r--r-- | docs/doxygen/other/stream_tags.dox | 5 |
2 files changed, 21 insertions, 1 deletions
diff --git a/docs/doxygen/other/pmt.dox b/docs/doxygen/other/pmt.dox index bc7f870ccd..51e1865d39 100644 --- a/docs/doxygen/other/pmt.dox +++ b/docs/doxygen/other/pmt.dox @@ -477,4 +477,21 @@ pmt::pmt_t a pmt::from_double(1.0); std::cout << "The PMT a contains " << a << std::endl; \endcode + +\section pmt_python Conversion between Python Objects and PMTs + +Although PMTs can be manipulated in Python using the Python versions +of the C++ interfaces, there are some additional goodies that make it +easier to work with PMTs in python. There are functions to automate +the conversion between PMTs and Python types for booleans, strings, +integers, longs, floats, complex numbers, dictionaries, lists, tuples +and combinations thereof. + +Two functions capture most of this functionality: + +\code +pmt.to_pmt # Converts a python object to a PMT. +pmt.to_python # Converts a PMT into a python object. +\endcode + */ diff --git a/docs/doxygen/other/stream_tags.dox b/docs/doxygen/other/stream_tags.dox index 851740984e..d48ec1ddee 100644 --- a/docs/doxygen/other/stream_tags.dox +++ b/docs/doxygen/other/stream_tags.dox @@ -61,7 +61,10 @@ at <em>nitems_written(0)+i</em> for the 0th output port. \section stream_tags_api Stream Tags API The stream tags API consists of four functions, two to add and two to -get the stream tags. These functions are: +get the stream tags. These functions are only meant to be accessed +within a call to general_work/work. While they can be called elsewhere +in time by a block, the behavior outside of work is undefined without +exact knowledge of the item counts in the buffers. \li gr::block::add_item_tag: Adds an item tag to a particular output port using a gr::tag_t data type. |