1 files changed, 144 insertions, 0 deletions
diff --git a/blocks/src/lib/hdu.h b/blocks/src/lib/hdu.h
new file mode 100644
index 0000000..0877199
--- /dev/null
+++ b/blocks/src/lib/hdu.h
@@ -0,0 +1,144 @@
+/* -*- C++ -*- */
+
+/*
+ * Copyright 2008 Steve Glass
+ * 
+ * This file is part of OP25.
+ * 
+ * OP25 is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ * 
+ * OP25 is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
+ * License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with OP25; see the file COPYING.  If not, write to the Free
+ * Software Foundation, Inc., 51 Franklin Street, Boston, MA
+ * 02110-1301, USA.
+*/
+
+#ifndef INCLUDED_HDU_H
+#define INCLUDED_HDU_H
+
+#include <abstract_data_unit.h>
+
+/**
+ * P25 header data unit (HDU).
+ */
+class hdu : public abstract_data_unit
+{
+
+public:
+
+   /**
+    * hdu constructor.
+    *
+    * \param frame_body A const_bit_queue representing the frame body.
+    */
+   hdu(const_bit_queue& frame_body);
+
+   /**
+    * hdu virtual destructor.
+    */
+   virtual ~hdu();
+
+   /**
+    * Returns a string describing the Data Unit ID (DUID).
+    */
+   std::string duid_str() const;
+
+   /**
+    * Return a snapshot of the key fields from this frame in a manner
+    * suitable for display by the UI. The string is encoded as a
+    * pickled Python dictionary.
+    * 
+    * \return A string containing the fields to display.
+    */
+   virtual std::string snapshot() const;
+
+protected:
+
+   /**
+    * Applies error correction code to the specified bit_vector.
+    *
+    * \param frame_body The bit vector to decode.
+    * \return 
+    */
+   virtual void do_correct_errors(bit_vector& frame_body);
+
+   /**
+    * Apply Golay error correction code to the specified bit_vector.
+    *
+    * \param frame_body The bit vector to decode.
+    * \return 
+    */
+   virtual void apply_golay_correction(bit_vector& frame_body);
+
+   /**
+    * Apply Reed-Solomon error correction code to the specified
+    * bit_vector.
+    *
+    * \param frame_body The bit vector to decode.
+    * \return 
+    */
+   virtual void apply_rs_correction(bit_vector& frame_body);
+
+   /**
+    * Returns the expected size (in bits) of this data unit in
+    * bits. For variable-length data this should return UINT16_MAX
+    * until the actual length of this frame is known.
+    *
+    * \return The expected size (in bits) of this data_unit when encoded.
+    */
+   virtual uint16_t frame_size_max() const;
+
+private:
+
+   /**
+    * Return a string describing the encryption algorithm ID (ALGID).
+    *
+    * \return A string identifying the ALGID.
+    */
+   std::string algid_str() const;
+
+   /**
+    * Returns a string describing the key id (KID).
+    *
+    * \return A string identifying the KID.
+    */
+   virtual std::string kid_str() const;
+
+   /**
+    * Returns a string describing the manufacturer ID (MFID).
+    *
+    * \return A string identifying the MFID
+    */
+   virtual std::string mfid_str() const;
+
+   /**
+    * Returns a string describing the message indicator (MI).
+    *
+    * \return A string identifying the MI.
+    */
+   virtual std::string mi_str() const;
+
+   /**
+    * Returns a string describing the Network Access Code (NAC).
+    *
+    * \return A string identifying the NAC.
+    */
+   virtual std::string nac_str() const;
+
+   /**
+    * Returns a string describing the talk group id (TGID).
+    *
+    * \return A string identifying the TGID.
+    */
+   virtual std::string tgid_str() const;
+};
+
+#endif /* INCLUDED_HDU_H */