From 46101d689a185f6a68b1fc2fe6ff61339e745b0f Mon Sep 17 00:00:00 2001 From: Marc Date: Fri, 10 Feb 2023 21:36:45 +0900 Subject: [PATCH 1/3] added difipack headers --- .../include/difipack/CMakeLists.txt | 9 + oot_rfnoc_difi/include/difipack/common.hpp | 20 + .../include/difipack/data_packet.hpp | 96 ++ oot_rfnoc_difi/include/difipack/packet.hpp | 213 +++++ oot_rfnoc_difi/include/difipack/prologue.hpp | 274 ++++++ .../difipack/standard_context_packet.hpp | 838 ++++++++++++++++++ .../difipack/version_context_packet.hpp | 210 +++++ 7 files changed, 1660 insertions(+) create mode 100644 oot_rfnoc_difi/include/difipack/CMakeLists.txt create mode 100644 oot_rfnoc_difi/include/difipack/common.hpp create mode 100644 oot_rfnoc_difi/include/difipack/data_packet.hpp create mode 100644 oot_rfnoc_difi/include/difipack/packet.hpp create mode 100644 oot_rfnoc_difi/include/difipack/prologue.hpp create mode 100644 oot_rfnoc_difi/include/difipack/standard_context_packet.hpp create mode 100644 oot_rfnoc_difi/include/difipack/version_context_packet.hpp diff --git a/oot_rfnoc_difi/include/difipack/CMakeLists.txt b/oot_rfnoc_difi/include/difipack/CMakeLists.txt new file mode 100644 index 0000000..f1a8a94 --- /dev/null +++ b/oot_rfnoc_difi/include/difipack/CMakeLists.txt @@ -0,0 +1,9 @@ +install(FILES + data_packet.hpp + packet.hpp + prologue.hpp + standard_context_packet.hpp + version_context_packet.hpp + common.hpp + DESTINATION include/difipack +) \ No newline at end of file diff --git a/oot_rfnoc_difi/include/difipack/common.hpp b/oot_rfnoc_difi/include/difipack/common.hpp new file mode 100644 index 0000000..d3c079e --- /dev/null +++ b/oot_rfnoc_difi/include/difipack/common.hpp @@ -0,0 +1,20 @@ +#pragma once + +namespace difipack +{ + //! An enum for the valid DIFI Time Source Integers (TSIs). + enum TSI + { + UTC = 0x1, + GPS = 0x2, + POSIX = 0x3 + }; + + //! An enum for the DIFI packet types. + enum PACKET_TYPE + { + DATA = 0x1, + STANDARD_CONTEXT = 0x4, + VERSION_CONTEXT = 0x5 + }; +} \ No newline at end of file diff --git a/oot_rfnoc_difi/include/difipack/data_packet.hpp b/oot_rfnoc_difi/include/difipack/data_packet.hpp new file mode 100644 index 0000000..1c0c98a --- /dev/null +++ b/oot_rfnoc_difi/include/difipack/data_packet.hpp @@ -0,0 +1,96 @@ +#include +#include + +#include +#include + +#pragma once + +namespace difipack +{ + /*! The class that represents a DIFI data packet. + */ + class data_packet : public difipack::packet + { + public: + class builder; + + /*! Serialize the data packet into a series of bytes. + * + * \param first the pointer to the first byte to serialize to + * \param last the pointer to the last byte to serialize to + * + * \throws std::invalid_argument when the destination range is too small + */ + void serialize(std::uint8_t *first, std::uint8_t *last); + + /*! Set the Information Class Code (ICC) of the data packet. + * + * \param icc the new icc + */ + void set_icc(std::uint16_t icc); + + /*! Set the Packet Class Code (PCC) of the data packet. + * + * \param pcc the new pcc + */ + void set_pcc(std::uint16_t pcc); + + /*! Get the current payload of the data packet. + * + * \returns the payload in byte vector form + */ + const std::vector &get_payload() const; + + /*! Set the payload of the packet. + * Automatically updates the packet length. + * + * \param payload the new payload, as a byte vector, to attach to this data packet + */ + void set_payload(std::vector payload); + + private: + data_packet(difipack::prologue prologue, std::vector payload); + + std::vector _payload; + }; + + /*! A builder class for data packets. + */ + class data_packet::builder : public difipack::packet::builder + { + public: + /*! Create a data packet builder. + * A DIFI data packet must have at least one item, so the payload is required. + * + * \param payload the payload, as a byte vector, to attach to this data packet builder + */ + builder(std::vector payload); + + /*! Set the Information Class Code (ICC) of the data packet builder. + * + * \param icc the new icc + */ + difipack::data_packet::builder *with_icc(std::uint16_t icc); + + /*! Set the Packet Class Code (PCC) of the data packet builder. + * + * \param pcc the new pcc + */ + difipack::data_packet::builder *with_pcc(std::uint16_t pcc); + + /*! Set the payload of the data packet builder. + * Automatically updates the packet length. + * + * \param payload the new payload, as a byte vector, to attach to this data packet builder + */ + difipack::data_packet::builder *with_payload(std::vector payload); + + /*! Build a data packet with the current builder configuration. + */ + difipack::data_packet build(); + + private: + std::vector _payload; + }; +} \ No newline at end of file diff --git a/oot_rfnoc_difi/include/difipack/packet.hpp b/oot_rfnoc_difi/include/difipack/packet.hpp new file mode 100644 index 0000000..95aadc2 --- /dev/null +++ b/oot_rfnoc_difi/include/difipack/packet.hpp @@ -0,0 +1,213 @@ +#include +#include +#include + +#include +#include + +#pragma once + +namespace difipack +{ + /*! The class that represents a generic DIFI packet. + */ + class packet + { + public: + /*! Serialize the packet into a series of bytes. + * + * \param first the pointer to the first byte to serialize to + * \param last the pointer to the last byte to serialize to + * + * \throws std::invalid_argument when the destination range is too small + */ + virtual void serialize(std::uint8_t *first, std::uint8_t *last) = 0; + + /*! Serialize the packet into a byte vector. + * + * \returns a byte vector containing the packet bytes + */ + std::vector serialize_to_byte_vector(); + + /*! Get the packet type. + * + * \returns the packet type + */ + difipack::PACKET_TYPE get_packet_type(); + + /*! Get the Time Source Integer (TSI) of the packet. + * + * \returns the tsi of the packet + */ + difipack::TSI get_tsi(); + + /*! Set the Time Source Integer (TSI) of the packet. + * + * \param tsi the new tsi + */ + void set_tsi(difipack::TSI tsi); + + /*! Get the packet sequence number (seqnum). + * + * \returns the seqnum of the packet + */ + std::uint8_t get_seqnum(); + + /*! Set the packet sequence number (seqnum). + * + * \param seqnum the new seqnum + */ + void set_seqnum(std::uint8_t seqnum); + + /*! Get the packet size in DIFI words. + * + * \returns the packet size in 32-bit DIFI words + */ + std::uint16_t get_packet_size(); + + /*! Get the Stream ID of the packet. + * + * \returns the stream id of the packet + */ + std::uint32_t get_stream_id(); + + /*! Set the Stream ID of the packet. + * + * \param stream_id the new stream id + */ + void set_stream_id(std::uint8_t stream_id); + + /*! Get the Organization Unique Identifier (OUI) of the packet. + * + * \returns the oui of the packet + */ + std::uint32_t get_oui(); + + /*! Set the Organization Unique Identifier (OUI) of the packet. + * + * \param oui the new oui + */ + void set_oui(std::uint32_t oui); + + /*! Get the Information Class Code (ICC) of the packet. + * + * \returns the icc of the packet + */ + std::uint16_t get_icc(); + + /*! Get the Packet Class Code (PCC) of the packet. + * + * \returns the pcc of the packet + */ + std::uint16_t get_pcc(); + + /*! Get the integer timestamp portion of the packet's timestamp. + * + * \returns the integer timestamp of the packet, as a 32-bit integer + */ + std::uint32_t get_int_timestamp(); + + /*! Set the integer timestamp portion of the packet's timestamp. + * + * \param int_timestamp the new integer timestamp of the packet, as a 32-bit integer + */ + void set_int_timestamp(std::uint32_t int_timestamp); + + /*! Get the fractional portion of the packet's timestamp + * + * \returns the fractional portion of the packet, as a 64-bit integer + */ + std::uint64_t get_frac_timestamp(); + + /*! Set the fractional timestamp portion of the packet's timestamp. + * + * \param frac_timestamp the new fractional timestamp of the packet, as a 32-bit integer + */ + void set_frac_timestamp(std::uint64_t frac_timestamp); + + protected: + /*! A generic builder class for other packet builders to inherit from. + */ + template + class builder + { + public: + /*! Creates a packet builder with a default prologue builder. + */ + builder(){}; + + /*! Set the Time Source Integer (TSI) of the packet builder. + * + * \param tsi the new tsi + */ + packet_builder *with_tsi(difipack::TSI tsi) + { + this->_prologue_builder.with_tsi(tsi); + return (packet_builder *)this; + }; + + /*! Set the packet sequence number (seqnum) builder. + * + * \param seqnum the new seqnum + */ + packet_builder *with_seqnum(std::uint8_t seqnum) + { + this->_prologue_builder.with_seqnum(seqnum); + return (packet_builder *)this; + }; + + /*! Set the Stream ID of the packet builder. + * + * \param stream_id the new stream id + */ + packet_builder *with_stream_id(std::uint32_t stream_id) + { + this->_prologue_builder.with_stream_id(stream_id); + return (packet_builder *)this; + }; + + /*! Set the Organization Unique Identifier (OUI) of the packet builder. + * + * \param oui the new oui + */ + packet_builder *with_oui(std::uint32_t oui) + { + this->_prologue_builder.with_oui(oui); + return (packet_builder *)this; + }; + + /*! Set the integer timestamp portion of the packet's timestamp builder. + * + * \param int_timestamp the new integer timestamp of the packet, as a 32-bit integer + */ + packet_builder *with_int_timestamp(std::uint32_t int_timestamp) + { + this->_prologue_builder.with_int_timestamp(int_timestamp); + return (packet_builder *)this; + }; + + /*! Set the fractional timestamp portion of the packet's timestamp builder. + * + * \param frac_timestamp the new fractional timestamp of the packet, as a 32-bit integer + */ + packet_builder *with_frac_timestamp(std::uint64_t frac_timestamp) + { + this->_prologue_builder.with_frac_timestamp(frac_timestamp); + return (packet_builder *)this; + }; + + protected: + difipack::prologue::builder _prologue_builder; //!< the DIFI prologue builder of this packet builder + }; + + packet() = delete; + + /*! Creates a DIFI packet with the given prologue + * + * \param prologue the prologue for this packet + */ + packet(difipack::prologue prologue); + + difipack::prologue _prologue; //!< the DIFI prologue of this packet + }; +} \ No newline at end of file diff --git a/oot_rfnoc_difi/include/difipack/prologue.hpp b/oot_rfnoc_difi/include/difipack/prologue.hpp new file mode 100644 index 0000000..07b1d80 --- /dev/null +++ b/oot_rfnoc_difi/include/difipack/prologue.hpp @@ -0,0 +1,274 @@ +#include +#include +#include +#include + +#include + +#pragma once + +namespace difipack +{ + /*! The class that represents the DIFI prologue. + * + * The prologue is the common first 7 words of each DIFI packet. + */ + class prologue + { + public: + class builder; + + static constexpr difipack::TSI DEFAULT_TSI = difipack::TSI::UTC; //!< The default TSI as defined by DIFI + static constexpr std::uint32_t DEFAULT_OUI = 0x7c386c; //!< The default OUI as defined by DIFI + static constexpr std::uint16_t DEFAULT_ICC = 0x0; //!< The default ICC as defined by DIFI + static constexpr std::uint16_t DEFAULT_PCC = 0x0; //!< The default PCC as defined by DIFI + + static constexpr std::size_t PROLOGUE_SIZE_WORDS = 7; //!< The size of the DIFI prologue in 32-bit words + static constexpr std::size_t PROLOGUE_SIZE_BYTES = difipack::prologue::PROLOGUE_SIZE_WORDS * 4; //!< The size of the DIFI prologue in bytes + + static const std::map STATIC_BITS; //!< A map corresponding to the unchanging bits of the prologue for each packet type + + /*! A basic constructor for a DIFI prologue object. + */ + prologue( + PACKET_TYPE packet_type, + difipack::TSI tsi, + std::uint8_t seqnum, + std::uint16_t packet_size, + std::uint32_t stream_id, + std::uint32_t oui, + std::uint16_t icc, + std::uint16_t pcc, + std::uint32_t int_timestamp, + std::uint64_t frac_timestamp); + + /*! Serialize the prologue into a series of bytes. + * + * \param first the pointer to the first byte to serialize to + * \param last the pointer to the last byte to serialize to + * + * \throws std::invalid_argument when the destination range is too small + */ + void serialize(std::uint8_t *first, std::uint8_t *last); + + /*! Get the packet type of the prologue. + * + * \returns the packet type of the prologue + */ + difipack::PACKET_TYPE get_packet_type(); + + /*! Set the packet type of the prologue. + * + * \param packet_type the new packet type + */ + void set_packet_type(difipack::PACKET_TYPE packet_type); + + /*! Get the Time Source Integer (TSI) of the prologue. + * + * \returns the tsi of the prologue + */ + difipack::TSI get_tsi(); + + /*! Set the Time Source Integer (TSI) of the prologue. + * + * \param tsi the new tsi + */ + void set_tsi(difipack::TSI tsi); + + /*! Get the sequence number (seqnum) of the prologue. + * + * \returns the seqnum of the prologue + */ + std::uint8_t get_seqnum(); + + /*! Set the sequence number (seqnum) of the prologue. + * + * \param seqnum the new seqnum + */ + void set_seqnum(std::uint8_t seqnum); + + /*! Get the packet size field of the prologue. + * + * \returns the packet size field + */ + std::uint16_t get_packet_size(); + + /*! Set the packet size field of the prologue. + * + * \param packet_size the new packet size + */ + void set_packet_size(std::uint16_t packet_size); + + /*! Get the Stream ID of the prologue. + * + * \returns the stream id of the prologue + */ + std::uint32_t get_stream_id(); + + /*! Set the Stream ID of the prologue. + * + * \param stream_id the new stream id + */ + void set_stream_id(std::uint8_t stream_id); + + /*! Get the Organization Unique Identifier (OUI) of the prologue. + * + * \returns the oui of the prologue + */ + std::uint32_t get_oui(); + + /*! Set the Organization Unique Identifier (OUI) of the prologue. + * + * \param oui the new oui + */ + void set_oui(std::uint32_t oui); + + /*! Get the Information Class Code (ICC) of the prologue. + * + * \returns the icc of the prologue + */ + std::uint16_t get_icc(); + + /*! Set the Information Class Code (ICC) of the prologue. + * + * \param icc the new icc + */ + void set_icc(std::uint16_t icc); + + /*! Get the Packet Class Code (PCC) of the prologue. + * + * \returns the pcc of the prologue + */ + std::uint16_t get_pcc(); + + /*! Set the Packet Class Code (PCC) of the prologue. + * + * \param pcc the new pcc + */ + void set_pcc(std::uint16_t pcc); + + /*! Get the integer timestamp portion of the prologue. + * + * \returns the integer timestamp field of the prologue + */ + std::uint32_t get_int_timestamp(); + + /*! Set the integer timestamp portion of the prologue. + * + * \param int_timestamp the new integer timestamp field + */ + void set_int_timestamp(std::uint32_t int_timestamp); + + /*! Get the fractional timestamp portion of the prologue. + * + * \returns the fractional timestamp field of the prologue + */ + std::uint64_t get_frac_timestamp(); + + /*! Set the fractional timestamp portion of the prologue. + * + * \param frac_timestamp the new fractional timestamp field + */ + void set_frac_timestamp(std::uint64_t frac_timestamp); + + private: + prologue() = delete; + + difipack::PACKET_TYPE _packet_type; + difipack::TSI _tsi; + std::uint8_t _seqnum; + std::uint16_t _packet_size; + std::uint32_t _stream_id; + std::uint32_t _oui; + std::uint16_t _icc; + std::uint16_t _pcc; + std::uint32_t _int_timestamp; + std::uint64_t _frac_timestamp; + }; + + /*! A builder class for prologues. + */ + class prologue::builder + { + public: + /*! Create a prologue builder with all default values. + */ + builder(); + + /*! Set the packet type of the prologue builder. + * + * \param packet_type the new packet type + */ + difipack::prologue::builder *with_packet_type(difipack::PACKET_TYPE packet_type); + + /*! Set the Time Source Integer (TSI) of the prologue builder. + * + * \param tsi the new tsi + */ + difipack::prologue::builder *with_tsi(difipack::TSI tsi); + + /*! Set the sequence number (seqnum) of the prologue builder. + * + * \param seqnum the new seqnum + */ + difipack::prologue::builder *with_seqnum(std::uint8_t seqnum); + + /*! Set the packet size field of the prologue builder. + * + * \param packet_size the new packet size + */ + difipack::prologue::builder *with_packet_size(std::uint16_t packet_size); + + /*! Set the Stream ID of the prologue builder. + * + * \param stream_id the new stream id + */ + difipack::prologue::builder *with_stream_id(std::uint32_t stream_id); + + /*! Set the Organization Unique Identifier (OUI) of the prologue builder. + * + * \param oui the new oui + */ + difipack::prologue::builder *with_oui(std::uint32_t oui); + + /*! Set the Information Class Code (ICC) of the prologue builder. + * + * \param icc the new icc + */ + difipack::prologue::builder *with_icc(std::uint16_t icc); + + /*! Set the Packet Class Code (PCC) of the prologue builder. + * + * \param pcc the new pcc + */ + difipack::prologue::builder *with_pcc(std::uint16_t pcc); + + /*! Set the integer timestamp portion of the prologue builder. + * + * \param int_timestamp the new integer timestamp field + */ + difipack::prologue::builder *with_int_timestamp(std::uint32_t int_timestamp); + + /*! Set the fractional timestamp portion of the prologue builder. + * + * \param frac_timestamp the new fractional timestamp field + */ + difipack::prologue::builder *with_frac_timestamp(std::uint64_t frac_timestamp); + + /*! Build a prologue with the current builder configuration. + */ + difipack::prologue build(); + + private: + difipack::PACKET_TYPE _packet_type; + difipack::TSI _tsi; + std::uint8_t _seqnum; + std::uint16_t _packet_size; + std::uint32_t _stream_id; + std::uint32_t _oui; + std::uint16_t _icc; + std::uint16_t _pcc; + std::uint32_t _int_timestamp; + std::uint64_t _frac_timestamp; + }; +} diff --git a/oot_rfnoc_difi/include/difipack/standard_context_packet.hpp b/oot_rfnoc_difi/include/difipack/standard_context_packet.hpp new file mode 100644 index 0000000..d2578bf --- /dev/null +++ b/oot_rfnoc_difi/include/difipack/standard_context_packet.hpp @@ -0,0 +1,838 @@ +#include +#include +#include + +#include + +#pragma once + +namespace difipack +{ + /*! The class that represents the DIFI standard context packet. + */ + class standard_context_packet : public difipack::packet + { + public: + //! An enum for the valid DIFI Context Indicator Field 0s (CIFs) for the standard context packet + enum CIF + { + CONTEXT_CHANGE = 0xfbb98000, + NO_CHANGE = 0x7bb98000 + }; + + /*! The class that represents the State and Event Indicators section of the standard context packet. + */ + class state_and_event_ind + { + public: + static const std::uint8_t CALIBRATED_TIME_ENABLER_POSITION = 31; //!< Bit position of the Calibrated Time Enabler field + static const std::uint8_t CALIBRATED_TIME_INDICATOR_POSITION = 19; //!< Bit position of the Calibrated Time Indicator field + static const std::uint8_t VALID_DATA_ENABLER_POSITION = 30; //!< Bit position of the Valid Data Enabler field + static const std::uint8_t VALID_DATA_INDICATOR_POSITION = 18; //!< Bit position of the Valid Data Indicator field + static const std::uint8_t REFERENCE_LOCK_ENABLER_POSITION = 29; //!< Bit position of the Reference Lock Enabler field + static const std::uint8_t REFERENCE_LOCK_INDICATOR_POSITION = 17; //!< Bit position of the Reference Lock Indicator field + static const std::uint8_t AGC_MGC_ENABLER_POSITION = 28; //!< Bit position of the Automatic Gain Control/Manual Gain Control Enabler field + static const std::uint8_t AGC_MGC_INDICATOR_POSITION = 16; //!< Bit position of the Automatic Gain Control/Manual Gain Control Indicator field + static const std::uint8_t DETECTED_SIGNAL_ENABLER_POSITION = 27; //!< Bit position of the Detected Signal Enabler field + static const std::uint8_t DETECTED_SIGNAL_INDICATOR_POSITION = 15; //!< Bit position of the Detected Signal Indicator field + static const std::uint8_t SPECTRAL_INVERSION_ENABLER_POSITION = 26; //!< Bit position of the Spectral Inversion Enabler field + static const std::uint8_t SPECTRAL_INVERSION_INDICATOR_POSITION = 14; //!< Bit position of the Spectral Inversion Indicator field + static const std::uint8_t OVER_RANGE_ENABLER_POSITION = 25; //!< Bit position of the Over-range Enabler field + static const std::uint8_t OVER_RANGE_INDICATOR_POSITION = 13; //!< Bit position of the Over-range Time Indicator field + static const std::uint8_t SAMPLE_LOSS_ENABLER_POSITION = 24; //!< Bit position of the Sample Loss Time Enabler field + static const std::uint8_t SAMPLE_LOSS_INDICATOR_POSITION = 12; //!< Bit position of the Sample Loss Time Indicator field + + /*! A constructor for a State and Event Indicator field that sets all bits to zero. + */ + state_and_event_ind(); + + /*! A constructor for a State and Event Indicator field that sets the bits to the input integer + * + * \param bits the integer to set the bits off of + */ + state_and_event_ind(std::uint32_t bits); + + /*! A constructor for a State and Event Indicator field that sets the bits to the input bitset + * + * \param bits the bitset to copy + */ + state_and_event_ind(std::bitset<32> bits); + + /*! Converts a State and Event Indicator field to an unsigned 32-bit integer. + */ + operator std::uint32_t(); + + /*! Returns the unsigned 32-bit integer form of this State and Event Indicator field. + * + * \returns a 32-bit integer representing this State and Event Indicator field + */ + std::uint32_t get_uint32_t(); + + /*! Get the Calibrated Time Enabler field. + * + * \returns the value of the calibrated time enabler + */ + bool get_calibrated_time_enabler(); + + /*! Set the Calibrated Time Enabler field. + * + * \param is_enabled the new value of the calibrated time enabler + */ + void set_calibrated_time_enabler(bool is_enabled); + + /*! Get the Calibrated Time Indicator field. + * + * \returns the value of the calibrated time indicator + */ + bool get_calibrated_time_indicator(); + + /*! Set the Calibrated Time Indicator field. + * + * \param is_indicated the new value of the calibrated time indicator + */ + void set_calibrated_time_indicator(bool is_indicated); + + /*! Get the Valid Data Enabler field. + * + * \returns the value of the valid data enabler + */ + bool get_valid_data_enabler(); + + /*! Set the Valid Data Enabler field. + * + * \param is_enabled the new value of the valid data enabler + */ + void set_valid_data_enabler(bool is_enabled); + + /*! Get the Valid Data Indicator field. + * + * \returns the value of the valid data indicator + */ + bool get_valid_data_indicator(); + + /*! Set the Valid Data Indicator field. + * + * \param is_indicated the new value of the valid data indicator + */ + void set_valid_data_indicator(bool is_indicated); + + /*! Get the Reference Lock Enabler field. + * + * \returns the value of the reference lock enabler + */ + bool get_reference_lock_enabler(); + + /*! Set the Reference Lock Enabler field. + * + * \param is_enabled the new value of the reference lock enabler + */ + void set_reference_lock_enabler(bool is_enabled); + + /*! Get the Reference Lock Indicator field. + * + * \returns the value of the reference lock indicator + */ + bool get_reference_lock_indicator(); + + /*! Set the Reference Lock Indicator field. + * + * \param is_indicated the new value of the reference lock indicator + */ + void set_reference_lock_indicator(bool is_indicated); + + /*! Get the Automatic Gain Control/Manual Gain Control (AGC/MGC) Enabler field. + * + * \returns the value of the agc/mgc enabler + */ + bool get_agc_mgc_enabler(); + + /*! Set the Automatic Gain Control/Manual Gain Control (AGC/MGC) Enabler field. + * + * \param is_enabled the new value of the agc/mgc enabler + */ + void set_agc_mgc_enabler(bool is_enabled); + + /*! Get the Automatic Gain Control/Manual Gain Control (AGC/MGC) Indicator field. + * + * \returns the value of the agc/mgc indicator + */ + bool get_agc_mgc_indicator(); + + /*! Set the Automatic Gain Control/Manual Gain Control (AGC/MGC) Indicator field. + * + * \param is_indicated the new value of the agc/mgc indicator + */ + void set_agc_mgc_indicator(bool is_indicated); + + /*! Get the Detected Signal Enabler field. + * + * \returns the value of the detected signal enabler + */ + bool get_detected_signal_enabler(); + + /*! Set the Detected Signal Enabler field. + * + * \param is_enabled the new value of the detected signal enabler + */ + void set_detected_signal_enabler(bool is_enabled); + + /*! Get the Detected Signal Indicator field. + * + * \returns the value of the detected signal indicator + */ + bool get_detected_signal_indicator(); + + /*! Set the Detected Signal Indicator field. + * + * \param is_indicated the new value of the detected signal indicator + */ + void set_detected_signal_indicator(bool is_indicated); + + /*! Get the Spectal Inversion Enabler field. + * + * \returns the value of the spectral inversion enabler + */ + bool get_spectral_inversion_enabler(); + + /*! Set the Spectal Inversion Enabler field. + * + * \param is_enabled the new value of the spectral inversion enabler + */ + void set_spectral_inversion_enabler(bool is_enabled); + + /*! Get the Spectal Inversion Indicator field. + * + * \returns the value of the spectral inversion indicator + */ + bool get_spectral_inversion_indicator(); + + /*! Set the Spectal Inversion Indicator field. + * + * \param is_indicated the new value of the spectral inversion indicator + */ + void set_spectral_inversion_indicator(bool is_indicated); + + /*! Get the Over-range Enabler field. + * + * \returns the value of the over-range enabler + */ + bool get_over_range_enabler(); + + /*! Set the Over-range Enabler field. + * + * \param is_enabled the new value of the over-range enabler + */ + void set_over_range_enabler(bool is_enabled); + + /*! Get the Over-range Indicator field. + * + * \returns the value of the over-range indicator + */ + bool get_over_range_indicator(); + + /*! Set the Over-range Indicator field. + * + * \param is_indicated the new value of the over-range indicator + */ + void set_over_range_indicator(bool is_indicated); + + /*! Get the Sample Loss Enabler field. + * + * \returns the value of the sample loss enabler + */ + bool get_sample_loss_time_enabler(); + + /*! Set the Sample Loss Enabler field. + * + * \param is_enabled the new value of the sample loss enabler + */ + void set_sample_loss_time_enabler(bool is_enabled); + + /*! Get the Sample Loss Indicator field. + * + * \returns the value of the sample loss indicator + */ + bool get_sample_loss_time_indicator(); + + /*! Set the Sample Loss Indicator field. + * + * \param is_indicated the new value of the sample loss indicator + */ + void set_sample_loss_time_indicator(bool is_indicated); + + /*! Get the user-defined flags section. + * + * \returns the byte representation of the user-defined flags + */ + std::uint8_t get_user_defined_bits(); + + /*! Set the user-defined flags section. + * + * \param bits a byte representing the user defined flags + */ + void set_user_defined_bits(std::uint8_t bits); + + private: + std::bitset<32> _bits; + }; + + /*! The class that represents the Data Packet Payload Format section of the standard context packet. + */ + class data_packet_payload_format + { + public: + //! An enum representing the valid Real/Complex Type field values + enum REAL_COMPLEX_TYPE + { + REAL = 0x0, + COMPLEX_CARTESIAN = 0x1, + COMPLEX_POLAR = 0x2 + }; + + //! An enum representing the valid Data Item Format field values + enum DATA_ITEM_FORMAT + { + SIGNED_FIXED_POINT = 0x00, + SIGNED_VRT_1_BIT_EXPONENT = 0x01, + SIGNED_VRT_2_BIT_EXPONENT = 0x02, + SIGNED_VRT_3_BIT_EXPONENT = 0x03, + SIGNED_VRT_4_BIT_EXPONENT = 0x04, + SIGNED_VRT_5_BIT_EXPONENT = 0x05, + SIGNED_VRT_6_BIT_EXPONENT = 0x06, + SIGNED_FIXED_POINT_NON_NORMALIZED = 0x07, + IEEE754_HALF_PRECISION_FLOATING_POINT = 0x0d, + IEEE754_SINGLE_PRECISION_FLOATING_POINT = 0x0e, + IEEE754_DOUBLE_PRECISION_FLOATING_POINT = 0x0f, + UNSIGNED_FIXED_POINT = 0x10, + UNSIGNED_VRT_1_BIT_EXPONENT = 0x11, + UNSIGNED_VRT_2_BIT_EXPONENT = 0x12, + UNSIGNED_VRT_3_BIT_EXPONENT = 0x13, + UNSIGNED_VRT_4_BIT_EXPONENT = 0x14, + UNSIGNED_VRT_5_BIT_EXPONENT = 0x15, + UNSIGNED_VRT_6_BIT_EXPONENT = 0x16, + UNSIGNED_FIXED_POINT_NON_NORMALIZED = 0x17 + }; + + static const std::uint8_t PACKING_METHOD_POSITION = 63; //!< Bit position of the Packing Method field + static const std::uint8_t REAL_COMPLEX_TYPE_POSITION = 61; //!< Bit position of the Real/Complex Type field + static const std::uint8_t DATA_ITEM_FORMAT_POSITION = 56; //!< Bit position of the Data Item Format field + static const std::uint8_t SAMPLE_COMPONENT_REPEAT_INDICATOR_POSITION = 55; //!< Bit position of the Sample Component Repeat Indicator field + static const std::uint8_t EVEN_TAG_SIZE_POSITION = 52; //!< Bit position of the Even Tag Size field + static const std::uint8_t CHANNEL_TAG_SIZE_POSITION = 48; //!< Bit position of the Channel Tag Size field + static const std::uint8_t DATA_ITEM_FRACTION_SIZE_POSITION = 44; //!< Bit position of the Data Item Fraction Size field + static const std::uint8_t ITEM_PACKING_FIELD_SIZE_POSITION = 38; //!< Bit position of the Item Packing Field Size field + static const std::uint8_t DATA_ITEM_SIZE_POSITION = 32; //!< Bit position of the Data Item Size field + static const std::uint8_t REPEAT_COUNT_POSITION = 16; //!< Bit position of the Repeat Count field + static const std::uint8_t VECTOR_SIZE_POSITION = 0; //!< Bit position of the Vector Size field + + /*! A constructor for a Data Packet Payload Format field that sets all bits to zero. + */ + data_packet_payload_format(); + + /*! A constructor for a SData Packet Payload Format field that sets the bits to the input integer + * + * \param bits the integer to set the bits off of + */ + data_packet_payload_format(std::uint64_t bits); + + /*! A constructor for a Data Packet Payload Format field that sets the bits to the input bitset + * + * \param bits the bitset to copy + */ + data_packet_payload_format(std::bitset<64> bits); + + /*! Converts a Data Packet Payload Format to an unsigned 64-bit integer. + */ + operator std::uint64_t(); + + /*! Returns the unsigned 64-bit integer form of this Data Packet Payload Format field. + * + * \returns a 64-bit integer representing this Data Packet Payload Format field + */ + std::uint64_t get_uint64_t(); + + /*! Get the Packing Method field. + * + * \returns the packing method + */ + bool get_packing_method(); + + /*! Set the Packing Method field. + * + * \param packing_method the new packing method + */ + void set_packing_method(bool packing_method); + + /*! Get the Real/Complex Type field. + * + * \returns the real/complex type + */ + difipack::standard_context_packet::data_packet_payload_format::REAL_COMPLEX_TYPE get_real_complex_type(); + + /*! Set the Real/Complex Type field. + * + * \param real_complex_type the new real/complex type + */ + void set_real_complex_type(difipack::standard_context_packet::data_packet_payload_format::REAL_COMPLEX_TYPE real_complex_type); + + /*! Get the Data Item Format field. + * + * \returns the data item format + */ + difipack::standard_context_packet::data_packet_payload_format::DATA_ITEM_FORMAT get_data_item_format(); + + /*! Set the Data Item Format field. + * + * \param data_item_format the new data item format + */ + void set_data_item_format(difipack::standard_context_packet::data_packet_payload_format::DATA_ITEM_FORMAT data_item_format); + + /*! Get the Sample Component Repeat Indicator field. + * + * \returns the sample component repeat indicator + */ + bool get_sample_component_repeat_indicator(); + + /*! Set the Sample Component Repeat Indicator field. + * + * \param sample_component_repeat_indicator the new sample component repeat indicator + */ + void set_sample_component_repeat_indicator(bool sample_component_repeat_indicator); + + /*! Get the Even Tag Size field. + * + * \returns the even tage size + */ + std::uint8_t get_even_tag_size(); + + /*! Set the Even Tag Size field. + * + * \param even_tag_size the new even tage size + */ + void set_even_tag_size(std::uint8_t even_tag_size); + + /*! Get the Channel Tag Size field. + * + * \returns the channel tag size + */ + std::uint8_t get_channel_tag_size(); + + /*! Set the Channel Tag Size field. + * + * \param channel_tag_size the new channel tag size + */ + void set_channel_tag_size(std::uint8_t channel_tag_size); + + /*! Get the Data Item Fraction Size field. + * + * \returns the data item fraction size + */ + std::uint8_t get_data_item_fraction_size(); + + /*! Set the Data Item Fraction Size field. + * + * \param data_item_fraction_size the new data item fraction size + */ + void set_data_item_fraction_size(std::uint8_t data_item_fraction_size); + + /*! Get the Item Packing Field Size field. + * + * \returns the item packing field size + */ + std::uint8_t get_item_packing_field_size(); + + /*! Set the Item Packing Field Size field. + * + * \param item_packing_field_size the new item packing field size + */ + void set_item_packing_field_size(std::uint8_t item_packing_field_size); + + /*! Get the Data Item Size field. + * + * \returns the data item size + */ + std::uint8_t get_data_item_size(); + + /*! Set the Data Item Size field. + * + * \param data_item_size the new data item size + */ + void set_data_item_size(std::uint8_t data_item_size); + + /*! Get the Repeat Count field. + * + * \returns the repeat count + */ + std::uint16_t get_repeat_count(); + + /*! Set the Repeat Count field. + * + * \param repeat_count the new repeat count + */ + void set_repeat_count(std::uint16_t repeat_count); + + /*! Get the Vector Size field. + * + * \returns the vector size + */ + std::uint16_t get_vector_size(); + + /*! Set the Vector Size field. + * + * \param vector_size the new vector size + */ + void set_vector_size(std::uint16_t vector_size); + + private: + std::bitset<64> _bits; + }; + + class builder; + + static constexpr std::size_t PACKET_SIZE_WORDS = 27; //!< The size of the standard context packet in 32-bit words + + /*! Serialize the standard context packet into a series of bytes. + * + * \param first the pointer to the first byte to serialize to + * \param last the pointer to the last byte to serialize to + * + * \throws std::invalid_argument when the destination range is too small + */ + void serialize(std::uint8_t *first, std::uint8_t *last); + + /*! Set the Information Class Code (ICC) of the standard context packet. + * + * \param icc the new icc + */ + void set_icc(std::uint16_t icc); + + /*! Set the Packet Class Code (PCC) of the standard context packet. + * + * \param pcc the new pcc + */ + void set_pcc(std::uint16_t pcc); + + /*! Get the Context Indicator Field 0 (CIF) of the standard context packet. + * + * \returns the cif0 + */ + difipack::standard_context_packet::CIF get_cif(); + + /*! Set the Context Indicator Field 0 (CIF) of the standard context packet. + * + * \param cif the new cif0 + */ + void set_cif(difipack::standard_context_packet::CIF cif); + + /*! Get the Reference Point of the standard context packet. + * + * \returns the reference point + */ + std::uint32_t get_ref_point(); + + /*! Set the Reference Point of the standard context packet. + * + * \param ref_point the new reference point + */ + void set_ref_point(std::uint32_t ref_point); + + /*! Get the Bandwidth of the standard context packet. + * + * \returns the bandwidth + */ + double get_bandwidth(); + + /*! Set the Bandwidth of the standard context packet. + * + * \param bandwidth the new bandwidth + */ + void set_bandwidth(double bandwidth); + + /*! Get the IF Reference Frequency of the standard context packet. + * + * \returns the if reference frequency + */ + double get_if_ref(); + + /*! Set the IF Reference Frequency of the standard context packet. + * + * \param if_ref the new if reference frequency + */ + void set_if_ref(double if_ref); + + /*! Get the RF Reference Frequency of the standard context packet. + * + * \returns the rf reference frequency + */ + double get_rf_ref(); + + /*! Set the RF Reference Frequency of the standard context packet. + * + * \param rf_ref the new rf reference frequency + */ + void set_rf_ref(double rf_ref); + + /*! Get the IF Band Offset of the standard context packet. + * + * \returns the if band offset + */ + double get_if_band_offset(); + + /*! Set the IF Band Offset of the standard context packet. + * + * \param if_band_offset the new if band offset + */ + void set_if_band_offset(double if_band_offset); + + /*! Get the Reference Level of the standard context packet. + * + * \returns the reference level + */ + float get_ref_level(); + + /*! Set the Reference Level of the standard context packet. + * + * \param ref_level the new reference level + */ + void set_ref_level(float ref_level); + + /*! Get the Stage 1 Gain/Attennuation of the standard context packet. + * + * \returns the stage 1 gain/attenuation + */ + float get_gain_att_stage1(); + + /*! Set the Stage 1 Gain/Attennuation of the standard context packet. + * + * \param gain_att_stage1 the new stage 1 gain/attenuation + */ + void set_gain_att_stage1(float gain_att_stage1); + + /*! Get the Stage 2 Gain/Attennuation of the standard context packet. + * + * \returns the stage 2 gain/attenuation + */ + float get_gain_att_stage2(); + + /*! Set the Stage 2 Gain/Attennuation of the standard context packet. + * + * \param gain_att_stage2 the new stage 2 gain/attenuation + */ + void set_gain_att_stage2(float gain_att_stage2); + + /*! Get the Sample Rate of the standard context packet. + * + * \returns the sample rate + */ + double get_sample_rate(); + + /*! Set the Sample Rate of the standard context packet. + * + * \param sample_rate the new sample rate + */ + void set_sample_rate(double sample_rate); + + /*! Get the Timestamp Adjustment of the standard context packet. + * + * \returns the timestamp adjustment + */ + std::int64_t get_ts_adj(); + + /*! Set the Timestamp Adjustment of the standard context packet. + * + * \param ts_adj the new timestamp adjustment + */ + void set_ts_adj(std::int64_t ts_adj); + + /*! Get the Timestamp Calibration Time of the standard context packet. + * + * \returns the timestamp calibration time + */ + std::uint32_t get_ts_cal_time(); + + /*! Set the Timestamp Calibration Time of the standard context packet. + * + * \param ts_cal_time the new timestamp calibration time + */ + void set_ts_cal_time(std::uint32_t ts_cal_time); + + /*! Get the State and Event Indicator field of the standard context packet. + * + * \returns the state and event indicator field + */ + difipack::standard_context_packet::state_and_event_ind get_state_and_event_ind(); + + /*! Set the State and Event Indicator field of the standard context packet. + * + * \param state_and_event_ind the new state and event indicator field + */ + void set_state_and_event_ind(difipack::standard_context_packet::state_and_event_ind state_and_event_ind); + + /*! Get the Data Packet Payload Format field of the standard context packet. + * + * \returns the data packet payload format + */ + difipack::standard_context_packet::data_packet_payload_format get_data_packet_payload_format(); + + /*! Set the Data Packet Payload Format field of the standard context packet. + * + * \param data_packet_payload_format the new data packet payload format + */ + void set_data_packet_payload_format(difipack::standard_context_packet::data_packet_payload_format data_packet_payload_format); + + private: + standard_context_packet( + difipack::prologue prologue, + difipack::standard_context_packet::CIF cif, + std::uint32_t ref_point, + double bandwidth, + double if_ref, + double rf_ref, + double if_band_offset, + float ref_level, + float gain_att_stage1, + float gain_att_stage2, + double sample_rate, + std::int64_t ts_adj, + std::uint32_t ts_cal_time, + difipack::standard_context_packet::state_and_event_ind state_event_ind, + difipack::standard_context_packet::data_packet_payload_format data_packet_payload_format); + + difipack::standard_context_packet::CIF _cif; + std::uint32_t _ref_point; + double _bandwidth; + double _if_ref; + double _rf_ref; + double _if_band_offset; + float _ref_level; + float _gain_att_stage1; + float _gain_att_stage2; + double _sample_rate; + std::int64_t _ts_adj; + std::uint32_t _ts_cal_time; + difipack::standard_context_packet::state_and_event_ind _state_and_event_ind; + difipack::standard_context_packet::data_packet_payload_format _data_packet_payload_format; + }; + + /*! A builder class for standard context packets. + */ + class standard_context_packet::builder : public difipack::packet::builder + { + public: + /*! Set the Information Class Code (ICC) of the standard context packet builder. + * + * \param icc the new icc + */ + difipack::standard_context_packet::builder *with_icc(std::uint16_t icc); + + /*! Set the Packet Class Code (PCC) of the standard context packet builder. + * + * \param pcc the new pcc + */ + difipack::standard_context_packet::builder *with_pcc(std::uint16_t pcc); + + /*! Set the Context Indicator Field 0 (CIF) of the standard context packet builder. + * + * \param cif the new cif0 + */ + difipack::standard_context_packet::builder *with_cif(difipack::standard_context_packet::CIF cif); + + /*! Set the Reference Point of the standard context packet builder. + * + * \param ref_point the new reference point + */ + difipack::standard_context_packet::builder *with_ref_point(std::uint32_t ref_point); + + /*! Set the Bandwidth of the standard context packet builder. + * + * \param bandwidth the new bandwidth + */ + difipack::standard_context_packet::builder *with_bandwidth(double bandwidth); + + /*! Set the IF Reference Frequency of the standard context packet builder. + * + * \param if_ref the new if reference frequency + */ + difipack::standard_context_packet::builder *with_if_ref(double if_ref); + + /*! Set the RF Reference Frequency of the standard context packet builder. + * + * \param rf_ref the new rf reference frequency + */ + difipack::standard_context_packet::builder *with_rf_ref(double rf_ref); + + /*! Set the IF Band Offset of the standard context packet builder. + * + * \param if_band_offset the new if band offset + */ + difipack::standard_context_packet::builder *with_if_band_offset(double if_band_offset); + + /*! Set the Reference Level of the standard context packet builder. + * + * \param ref_level the new reference level + */ + difipack::standard_context_packet::builder *with_ref_level(float ref_level); + + /*! Set the Stage 1 Gain/Attennuation of the standard context packet builder. + * + * \param gain_att_stage1 the new stage 1 gain/attenuation + */ + difipack::standard_context_packet::builder *with_gain_att_stage1(float gain_att_stage1); + + /*! Set the Stage 2 Gain/Attennuation of the standard context packet builder. + * + * \param gain_att_stage2 the new stage 2 gain/attenuation + */ + difipack::standard_context_packet::builder *with_gain_att_stage2(float gain_att_stage2); + + /*! Set the Sample Rate of the standard context packet builder. + * + * \param sample_rate the new sample rate + */ + difipack::standard_context_packet::builder *with_sample_rate(double sample_rate); + + /*! Set the Timestamp Adjustment of the standard context packet builder. + * + * \param ts_adj the new timestamp adjustment + */ + difipack::standard_context_packet::builder *with_ts_adj(std::int64_t ts_adj); + + /*! Set the Timestamp Calibration Time of the standard context packet builder. + * + * \param ts_cal_time the new timestamp calibration time + */ + difipack::standard_context_packet::builder *with_ts_cal_time(std::uint32_t ts_cal_time); + + /*! Set the State and Event Indicator field of the standard context packet builder. + * + * \param state_and_event_ind the new state and event indicator field + */ + difipack::standard_context_packet::builder *with_state_and_event_ind(difipack::standard_context_packet::state_and_event_ind state_and_event_ind); + + /*! Set the Data Packet Payload Format field of the standard context packet builder. + * + * \param data_packet_payload_format the new data packet payload format + */ + difipack::standard_context_packet::builder *with_data_packet_payload_format(difipack::standard_context_packet::data_packet_payload_format data_packet_payload_format); + + /*! Build a standard context packet with the current builder configuration. + */ + difipack::standard_context_packet build(); + + private: + difipack::standard_context_packet::CIF _cif = difipack::standard_context_packet::CIF::CONTEXT_CHANGE; + std::uint32_t _ref_point = 0; + double _bandwidth = 0; + double _if_ref = 0; + double _rf_ref = 0; + double _if_band_offset = 0; + float _ref_level = 0; + float _gain_att_stage1 = 0; + float _gain_att_stage2 = 0; + double _sample_rate = 0; + std::int64_t _ts_adj = 0; + std::uint32_t _ts_cal_time = 0; + difipack::standard_context_packet::state_and_event_ind _state_and_event_ind; + difipack::standard_context_packet::data_packet_payload_format _data_packet_payload_format; + }; +} \ No newline at end of file diff --git a/oot_rfnoc_difi/include/difipack/version_context_packet.hpp b/oot_rfnoc_difi/include/difipack/version_context_packet.hpp new file mode 100644 index 0000000..7b8f98a --- /dev/null +++ b/oot_rfnoc_difi/include/difipack/version_context_packet.hpp @@ -0,0 +1,210 @@ +#include +#include + +#include + +#pragma once + +namespace difipack +{ + /*! The class that represents the DIFI version context packet. + */ + class version_context_packet : public packet + { + public: + //! An enum for the valid DIFI Context Indicator Field 0s (CIFs) for the version context packet + enum CIF0 + { + CONTEXT_CHANGE = 0x80000002, + NO_CHANGE = 0x00000002 + }; + + //! An enum for the valid Types of devices for the version context packet + enum TYPE + { + NARROWBAND = 0, + WIDEBAND = 1 + }; + + //! An enum for the valid ICD Versions for the version context packet + enum ICD_VERSION + { + V_1 = 0 + }; + + class builder; + + static constexpr std::uint16_t VERSION_CONTEXT_ICC = 0x001; //!< The only valid value for the ICC field of a version context packet + static constexpr std::uint16_t VERSION_CONTEXT_PCC = 0x004; //!< The only valid value for the PCC field of a version context packet + static constexpr std::uint16_t VERSION_CONTEXT_CIF1 = 0x0000000C; //!< The only valid value for the CIF1 field of a version context packet + static constexpr std::uint16_t VERSION_CONTEXT_V49_SPEC_VERSION = 0x00000004; //!< The only valid value for the V49 Spec Version field of a version context packet + + static constexpr std::uint16_t PACKET_SIZE_WORDS = 11; //!< The size of the version context packet in 32-bit words + + /*! Serialize the version context packet into a series of bytes. + * + * \param first the pointer to the first byte to serialize to + * \param last the pointer to the last byte to serialize to + * + * \throws std::invalid_argument when the destination range is too small + */ + void serialize(std::uint8_t *first, std::uint8_t *last); + + /*! Get the Context Indicator Field 0 (CIF0) of the version context packet. + * + * \returns the cif0 + */ + difipack::version_context_packet::CIF0 get_cif0(); + + /*! Set the Context Indicator Field 0 (CIF0) of the version context packet. + * + * \param cif0 the new cif0 + */ + void set_cif0(difipack::version_context_packet::CIF0 cif0); + + /*! Get the Context Indicator Field 1 (CIF1) of the version context packet. + * + * \returns the cif1 + */ + const std::uint32_t get_cif1(); + + /*! Get the V49 Spec Version of the version context packet. + * + * \returns the v49 spec version + */ + const std::uint32_t get_v49_spec_version(); + + /*! Get the Year field of the version context packet. + * + * \returns the year field + */ + std::uint8_t get_year(); + + /*! Set the Year field of the version context packet. + * + * \param year the new year field + */ + void set_year(std::uint8_t year); + + /*! Get the Day field of the version context packet. + * + * \returns the day field + */ + std::uint16_t get_day(); + + /*! Set the Day field of the version context packet. + * + * \param day the new day field + */ + void set_day(std::uint16_t day); + + /*! Get the Revision field of the version context packet. + * + * \returns the revision field + */ + std::uint8_t get_revision(); + + /*! Set the Revision field of the version context packet. + * + * \param revision the new revision field + */ + void set_revision(std::uint8_t revision); + + /*! Get the Type field of the version context packet. + * + * \returns the type field + */ + difipack::version_context_packet::TYPE get_type(); + + /*! Set the Type field of the version context packet. + * + * \param type the new type field + */ + void set_type(difipack::version_context_packet::TYPE type); + + /*! Get the ICD Version of the version context packet. + * + * \returns the icd version + */ + difipack::version_context_packet::ICD_VERSION get_icd_version(); + + /*! Set the ICD Version of the version context packet. + * + * \param icd_version the new icd version + */ + void set_icd_version(difipack::version_context_packet::ICD_VERSION icd_version); + + private: + version_context_packet( + difipack::prologue prologue, + difipack::version_context_packet::CIF0 cif0, + std::uint8_t year, + std::uint16_t day, + std::uint8_t revision, + difipack::version_context_packet::TYPE type, + difipack::version_context_packet::ICD_VERSION icd_version); + + difipack::version_context_packet::CIF0 _cif0; + const std::uint32_t _cif1 = VERSION_CONTEXT_CIF1; + const std::uint32_t _v49_spec_version = VERSION_CONTEXT_V49_SPEC_VERSION; + std::uint8_t _year; + std::uint16_t _day; + std::uint8_t _revision; + difipack::version_context_packet::TYPE _type; + difipack::version_context_packet::ICD_VERSION _icd_version; + }; + + /*! A builder class for version context packets. + */ + class version_context_packet::builder : public difipack::packet::builder + { + public: + /*! Set the Context Indicator Field 0 (CIF0) of the version context packet builder. + * + * \param cif0 the new cif0 + */ + difipack::version_context_packet::builder *with_cif0(difipack::version_context_packet::CIF0 cif0); + + /*! Set the Year field of the version context packet builder. + * + * \param year the new year field + */ + difipack::version_context_packet::builder *with_year(std::uint8_t year); + + /*! Set the Day field of the version context packet builder. + * + * \param day the new day field + */ + difipack::version_context_packet::builder *with_day(std::uint16_t day); + + /*! Set the Revision field of the version context packet builder. + * + * \param revision the new revision field + */ + difipack::version_context_packet::builder *with_revision(std::uint8_t revision); + + /*! Set the Type field of the version context packet builder. + * + * \param type the new type field + */ + difipack::version_context_packet::builder *with_type(difipack::version_context_packet::TYPE type); + + /*! Set the ICD Version of the version context packet builder. + * + * \param icd_version the new icd version + */ + difipack::version_context_packet::builder *with_icd_version(difipack::version_context_packet::ICD_VERSION icd_version); + + /*! Build a version context packet with the current builder configuration. + */ + difipack::version_context_packet build(); + + private: + difipack::version_context_packet::CIF0 _cif0 = difipack::version_context_packet::CIF0::CONTEXT_CHANGE; + std::uint8_t _year = 0; + std::uint16_t _day = 0; + std::uint8_t _revision = 0; + difipack::version_context_packet::TYPE _type = difipack::version_context_packet::TYPE::NARROWBAND; + difipack::version_context_packet::ICD_VERSION _icd_version = difipack::version_context_packet::ICD_VERSION::V_1; + }; +} \ No newline at end of file From 7b1418ec2729de4b7587d64b779678178d6e4595 Mon Sep 17 00:00:00 2001 From: Marc Lichtman Date: Fri, 10 Feb 2023 21:43:03 +0900 Subject: [PATCH 2/3] added to cmake --- oot_rfnoc_difi/CMakeLists.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/oot_rfnoc_difi/CMakeLists.txt b/oot_rfnoc_difi/CMakeLists.txt index 462c945..4960003 100644 --- a/oot_rfnoc_difi/CMakeLists.txt +++ b/oot_rfnoc_difi/CMakeLists.txt @@ -176,6 +176,7 @@ if(UHD_FPGA_DIR) endif() if(UHD_FOUND) add_subdirectory(include/rfnoc/difi) + add_subdirectory(include/difipack) add_subdirectory(lib) add_subdirectory(apps) endif() From 75a540c789bad598c094d82f3556272ae3e1e35c Mon Sep 17 00:00:00 2001 From: Marc Date: Fri, 10 Feb 2023 22:05:57 +0900 Subject: [PATCH 3/3] added difipack altogether --- difipack-cpp/CMakeLists.txt | 38 + difipack-cpp/README.md | 64 + difipack-cpp/cmake/cmake_uninstall.cmake.in | 32 + difipack-cpp/docs/CMakeLists.txt | 26 + difipack-cpp/docs/Doxyfile.in | 2579 +++++++++++++++++ difipack-cpp/examples/CMakeLists.txt | 5 + difipack-cpp/examples/README.md | 30 + difipack-cpp/examples/uhd_to_difi.cpp | 246 ++ .../include/difipack/CMakeLists.txt | 0 .../include/difipack/common.hpp | 0 .../include/difipack/data_packet.hpp | 0 .../include/difipack/packet.hpp | 0 .../include/difipack/prologue.hpp | 0 .../difipack/standard_context_packet.hpp | 0 .../difipack/version_context_packet.hpp | 0 difipack-cpp/lib/CMakeLists.txt | 16 + difipack-cpp/lib/data_packet/CMakeLists.txt | 4 + difipack-cpp/lib/data_packet/builder.cpp | 26 + difipack-cpp/lib/data_packet/data_packet.cpp | 41 + difipack-cpp/lib/packet.cpp | 90 + difipack-cpp/lib/prologue/CMakeLists.txt | 4 + difipack-cpp/lib/prologue/builder.cpp | 90 + difipack-cpp/lib/prologue/prologue.cpp | 142 + .../standard_context_packet/CMakeLists.txt | 6 + .../lib/standard_context_packet/builder.cpp | 119 + .../data_packet_payload_format.cpp | 129 + .../standard_context_packet.cpp | 195 ++ .../state_and_event_ind.cpp | 189 ++ difipack-cpp/lib/utils/CMakeLists.txt | 5 + difipack-cpp/lib/utils/bit_utils.hpp | 3 + difipack-cpp/lib/utils/bitset_utils.hpp | 25 + difipack-cpp/lib/utils/packing_utils.hpp | 53 + .../lib/version_context_packet/CMakeLists.txt | 4 + .../lib/version_context_packet/builder.cpp | 53 + .../version_context_packet.cpp | 103 + difipack-cpp/test/CMakeLists.txt | 24 + difipack-cpp/test/test_data_packet.cpp | 58 + .../test/test_standard_context_packet.cpp | 99 + .../test/test_version_context_packet.cpp | 63 + oot_rfnoc_difi/CMakeLists.txt | 1 - 40 files changed, 4561 insertions(+), 1 deletion(-) create mode 100644 difipack-cpp/CMakeLists.txt create mode 100644 difipack-cpp/README.md create mode 100644 difipack-cpp/cmake/cmake_uninstall.cmake.in create mode 100644 difipack-cpp/docs/CMakeLists.txt create mode 100644 difipack-cpp/docs/Doxyfile.in create mode 100644 difipack-cpp/examples/CMakeLists.txt create mode 100644 difipack-cpp/examples/README.md create mode 100644 difipack-cpp/examples/uhd_to_difi.cpp rename {oot_rfnoc_difi => difipack-cpp}/include/difipack/CMakeLists.txt (100%) rename {oot_rfnoc_difi => difipack-cpp}/include/difipack/common.hpp (100%) rename {oot_rfnoc_difi => difipack-cpp}/include/difipack/data_packet.hpp (100%) rename {oot_rfnoc_difi => difipack-cpp}/include/difipack/packet.hpp (100%) rename {oot_rfnoc_difi => difipack-cpp}/include/difipack/prologue.hpp (100%) rename {oot_rfnoc_difi => difipack-cpp}/include/difipack/standard_context_packet.hpp (100%) rename {oot_rfnoc_difi => difipack-cpp}/include/difipack/version_context_packet.hpp (100%) create mode 100644 difipack-cpp/lib/CMakeLists.txt create mode 100644 difipack-cpp/lib/data_packet/CMakeLists.txt create mode 100644 difipack-cpp/lib/data_packet/builder.cpp create mode 100644 difipack-cpp/lib/data_packet/data_packet.cpp create mode 100644 difipack-cpp/lib/packet.cpp create mode 100644 difipack-cpp/lib/prologue/CMakeLists.txt create mode 100644 difipack-cpp/lib/prologue/builder.cpp create mode 100644 difipack-cpp/lib/prologue/prologue.cpp create mode 100644 difipack-cpp/lib/standard_context_packet/CMakeLists.txt create mode 100644 difipack-cpp/lib/standard_context_packet/builder.cpp create mode 100644 difipack-cpp/lib/standard_context_packet/data_packet_payload_format.cpp create mode 100644 difipack-cpp/lib/standard_context_packet/standard_context_packet.cpp create mode 100644 difipack-cpp/lib/standard_context_packet/state_and_event_ind.cpp create mode 100644 difipack-cpp/lib/utils/CMakeLists.txt create mode 100644 difipack-cpp/lib/utils/bit_utils.hpp create mode 100644 difipack-cpp/lib/utils/bitset_utils.hpp create mode 100644 difipack-cpp/lib/utils/packing_utils.hpp create mode 100644 difipack-cpp/lib/version_context_packet/CMakeLists.txt create mode 100644 difipack-cpp/lib/version_context_packet/builder.cpp create mode 100644 difipack-cpp/lib/version_context_packet/version_context_packet.cpp create mode 100644 difipack-cpp/test/CMakeLists.txt create mode 100644 difipack-cpp/test/test_data_packet.cpp create mode 100644 difipack-cpp/test/test_standard_context_packet.cpp create mode 100644 difipack-cpp/test/test_version_context_packet.cpp diff --git a/difipack-cpp/CMakeLists.txt b/difipack-cpp/CMakeLists.txt new file mode 100644 index 0000000..f3e8ad4 --- /dev/null +++ b/difipack-cpp/CMakeLists.txt @@ -0,0 +1,38 @@ +cmake_minimum_required(VERSION 3.12) +project(difipack + VERSION 0.0.1 + DESCRIPTION "C++ implementation of DIFI packet objects" + LANGUAGES CXX +) + +enable_testing() + +set(CMAKE_EXPORT_COMPILE_COMMANDS ON) + +add_compile_options(-fPIC) + +configure_file( + ${CMAKE_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in + ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake +@ONLY) + +add_custom_target(uninstall + ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake +) + +add_subdirectory(include/difipack) +add_subdirectory(lib) +add_subdirectory(examples) +add_subdirectory(test) + +option(BUILD_WITH_DOCS "Generate Docs" OFF) +if(BUILD_WITH_DOCS) + add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/docs) +endif() + +install( + TARGETS difipack + LIBRARY DESTINATION lib + ARCHIVE DESTINATION lib + RUNTIME DESTINATION bin +) \ No newline at end of file diff --git a/difipack-cpp/README.md b/difipack-cpp/README.md new file mode 100644 index 0000000..d35c026 --- /dev/null +++ b/difipack-cpp/README.md @@ -0,0 +1,64 @@ +# DIFI Packet C++ Library + +## Prerequisites + +UHD, gcc/g++, CMake, Boost unit testing framework, and some build system compatible with Cmake + +We recommend building UHD from source, however you can download from some package managers. + +### Linux (Ubuntu/Debian) + +``` bash +sudo apt install gcc cmake make libboost-test-dev +``` + +## Installing + +Configure/generate the build files: + +``` bash +# chdr_difi/difipack +mkdir build +cd build +cmake ../ +``` + +Make and install the library + +``` bash +make +sudo make install +sudo ldconfig +``` + +## Uninstalling + +The package can be uninstalled by running the following from the build directory created during installation. + +``` bash +make uninstall +``` + +## Running the tests + +After building the library, the tests can be run with `make test`. You need boost's unit test framework. + +## Building the Docs + +Before building the docs, you need to install Doxygen and Graphviz (e.g., `sudo apt install doxygen graphviz`). + +Run CMake with the option `-DBUILD_WITH_DOCS=ON`, and then use `make docs` to generate the docs. + +``` bash +# chdr_difi/difipack +mkdir build +cd build +cmake -DBUILD_WITH_DOCS=ON ../ +make docs +``` + +The index file can be found at `build/docs/html/index.html`. + +## Built With + +Ubuntu, VSCode (and C++ Extensions) diff --git a/difipack-cpp/cmake/cmake_uninstall.cmake.in b/difipack-cpp/cmake/cmake_uninstall.cmake.in new file mode 100644 index 0000000..c0fa3e6 --- /dev/null +++ b/difipack-cpp/cmake/cmake_uninstall.cmake.in @@ -0,0 +1,32 @@ +# http://www.vtk.org/Wiki/CMake_FAQ#Can_I_do_.22make_uninstall.22_with_CMake.3F + +IF(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") + MESSAGE(FATAL_ERROR "Cannot find install manifest: \"@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt\"") +ENDIF(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") + +FILE(READ "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt" files) +STRING(REGEX REPLACE "\n" ";" files "${files}") +FOREACH(file ${files}) + MESSAGE(STATUS "Uninstalling \"$ENV{DESTDIR}${file}\"") + IF(EXISTS "$ENV{DESTDIR}${file}") + EXEC_PROGRAM( + "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\"" + OUTPUT_VARIABLE rm_out + RETURN_VALUE rm_retval + ) + IF(NOT "${rm_retval}" STREQUAL 0) + MESSAGE(FATAL_ERROR "Problem when removing \"$ENV{DESTDIR}${file}\"") + ENDIF(NOT "${rm_retval}" STREQUAL 0) + ELSEIF(IS_SYMLINK "$ENV{DESTDIR}${file}") + EXEC_PROGRAM( + "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\"" + OUTPUT_VARIABLE rm_out + RETURN_VALUE rm_retval + ) + IF(NOT "${rm_retval}" STREQUAL 0) + MESSAGE(FATAL_ERROR "Problem when removing \"$ENV{DESTDIR}${file}\"") + ENDIF(NOT "${rm_retval}" STREQUAL 0) + ELSE(EXISTS "$ENV{DESTDIR}${file}") + MESSAGE(STATUS "File \"$ENV{DESTDIR}${file}\" does not exist.") + ENDIF(EXISTS "$ENV{DESTDIR}${file}") +ENDFOREACH(file) \ No newline at end of file diff --git a/difipack-cpp/docs/CMakeLists.txt b/difipack-cpp/docs/CMakeLists.txt new file mode 100644 index 0000000..e677362 --- /dev/null +++ b/difipack-cpp/docs/CMakeLists.txt @@ -0,0 +1,26 @@ +find_package(Doxygen) +if(DOXYGEN_FOUND) + # Set Doxygen input and output files. + set(DOXYGEN_INPUT_DIRS ${CMAKE_SOURCE_DIR}/include) + set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen) + set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml) + set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) + set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) + + # Generate DoxyFile from the input file. + configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY) + + # Create Output directory. + file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR}) + + # Command for generating doc from Doxygen config file. + add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE} + COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT} + MAIN_DEPENDENCY ${DOXYFILE_OUT} ${DOXYFILE_IN} + COMMENT "Generating Doxygen documentation" + VERBATIM) + # Create CMake Target for generating doc. + add_custom_target(docs ALL DEPENDS ${DOXYGEN_INDEX_FILE}) +else() + message(STATUS "Doxygen not found: skipping docs") +endif() \ No newline at end of file diff --git a/difipack-cpp/docs/Doxyfile.in b/difipack-cpp/docs/Doxyfile.in new file mode 100644 index 0000000..00b49d1 --- /dev/null +++ b/difipack-cpp/docs/Doxyfile.in @@ -0,0 +1,2579 @@ +# Doxyfile 1.8.17 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "difipack" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is +# Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# (including Cygwin) ands Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = @DOXYGEN_INPUT_DIRS@ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen +# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.doc \ + *.txt \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files +# were built. This is equivalent to specifying the "-p" option to a clang tool, +# such as clang-check. These options will then be passed to the parser. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /