summaryrefslogtreecommitdiff
path: root/gr-digital/include/gnuradio/digital/protocol_parser_b.h
diff options
context:
space:
mode:
Diffstat (limited to 'gr-digital/include/gnuradio/digital/protocol_parser_b.h')
-rw-r--r--gr-digital/include/gnuradio/digital/protocol_parser_b.h82
1 files changed, 41 insertions, 41 deletions
diff --git a/gr-digital/include/gnuradio/digital/protocol_parser_b.h b/gr-digital/include/gnuradio/digital/protocol_parser_b.h
index 89c7f7edd3..d3e6b79ccf 100644
--- a/gr-digital/include/gnuradio/digital/protocol_parser_b.h
+++ b/gr-digital/include/gnuradio/digital/protocol_parser_b.h
@@ -29,52 +29,52 @@
#include <gnuradio/sync_block.h>
namespace gr {
- namespace digital {
+namespace digital {
+
+/*!
+ * \brief Block that synchronizes to a header based on a header
+ * format object class. Designed to accept hard bits and produce
+ * PDUs with packed bytes (pmt::u8vector).
+ *
+ * \ingroup packet_operators_blk
+ *
+ * \details
+ *
+ * A packet synchronizer block. This block takes in hard bits
+ * (unpacked bytes; 1's and 0's as the LSB) and finds the access
+ * code as a sync word to find the start of a frame.
+ *
+ * The block uses a format object derived from a
+ * header_format_base class.
+ *
+ * Once the frame is detected (usually through the use of an
+ * access code), the block uses the format object's parser
+ * function to decode the remaining header. Generally, as in the
+ * default header case, the header will contain the length of the
+ * frame's payload. That and anything else in the header will
+ * generally go into the PDU's meta-data dictionary.
+ *
+ * The block will output a PDU that contains frame's header info
+ * in the meta-data portion of the PDU and the payload itself. The
+ * payload is packed hard bits as taken from the input stream.
+ *
+ * \sa packet_sync_ff for a soft decision version.
+ */
+class DIGITAL_API protocol_parser_b : virtual public sync_block
+{
+public:
+ typedef boost::shared_ptr<protocol_parser_b> sptr;
/*!
- * \brief Block that synchronizes to a header based on a header
- * format object class. Designed to accept hard bits and produce
- * PDUs with packed bytes (pmt::u8vector).
- *
- * \ingroup packet_operators_blk
- *
- * \details
- *
- * A packet synchronizer block. This block takes in hard bits
- * (unpacked bytes; 1's and 0's as the LSB) and finds the access
- * code as a sync word to find the start of a frame.
+ * Make a packet header block using a given \p format.
*
- * The block uses a format object derived from a
- * header_format_base class.
- *
- * Once the frame is detected (usually through the use of an
- * access code), the block uses the format object's parser
- * function to decode the remaining header. Generally, as in the
- * default header case, the header will contain the length of the
- * frame's payload. That and anything else in the header will
- * generally go into the PDU's meta-data dictionary.
- *
- * The block will output a PDU that contains frame's header info
- * in the meta-data portion of the PDU and the payload itself. The
- * payload is packed hard bits as taken from the input stream.
- *
- * \sa packet_sync_ff for a soft decision version.
+ * \param format The format object to use when reading the
+ * header.
*/
- class DIGITAL_API protocol_parser_b : virtual public sync_block
- {
- public:
- typedef boost::shared_ptr<protocol_parser_b> sptr;
-
- /*!
- * Make a packet header block using a given \p format.
- *
- * \param format The format object to use when reading the
- * header.
- */
- static sptr make(const header_format_base::sptr &format);
- };
+ static sptr make(const header_format_base::sptr& format);
+};
- } // namespace digital
+} // namespace digital
} // namespace gr
#endif /* INCLUDED_DIGITAL_PROTOCOL_PARSER_B_H */