[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Commit-gnuradio] [gnuradio] 03/05: docs: adding info on python-pmt conv
From: |
git |
Subject: |
[Commit-gnuradio] [gnuradio] 03/05: docs: adding info on python-pmt converters into pmt manual page. |
Date: |
Mon, 13 Oct 2014 20:31:18 +0000 (UTC) |
This is an automated email from the git hooks/post-receive script.
jcorgan pushed a commit to branch master
in repository gnuradio.
commit 559a0fef07612d75881003f1fbb785ad5fe86b93
Author: Tom Rondeau <address@hidden>
Date: Fri Oct 10 16:06:46 2014 -0400
docs: adding info on python-pmt converters into pmt manual page.
---
docs/doxygen/other/pmt.dox | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/docs/doxygen/other/pmt.dox b/docs/doxygen/other/pmt.dox
index bc7f870..51e1865 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
+
*/