mirror of
https://github.com/ciphervance/supercell-wx.git
synced 2025-10-31 16:40:04 +00:00
87 lines
2.6 KiB
C++
87 lines
2.6 KiB
C++
#pragma once
|
|
|
|
#include <chrono>
|
|
#include <memory>
|
|
#include <optional>
|
|
#include <string>
|
|
|
|
namespace scwx::awips
|
|
{
|
|
|
|
class WmoHeaderImpl;
|
|
|
|
/**
|
|
* @brief The WMO Header is defined in WMO Manual No. 386, with additional codes
|
|
* defined in WMO Codes Manual 306. The NWS summarizes the relevant
|
|
* information.
|
|
*
|
|
* <https://www.roc.noaa.gov/WSR88D/Level_III/Level3Info.aspx>
|
|
* <https://www.weather.gov/tg/head>
|
|
* <https://www.weather.gov/tg/headef>
|
|
* <https://www.weather.gov/tg/bbb>
|
|
* <https://www.weather.gov/tg/awips>
|
|
*/
|
|
class WmoHeader
|
|
{
|
|
public:
|
|
explicit WmoHeader();
|
|
~WmoHeader();
|
|
|
|
WmoHeader(const WmoHeader&) = delete;
|
|
WmoHeader& operator=(const WmoHeader&) = delete;
|
|
|
|
WmoHeader(WmoHeader&&) noexcept;
|
|
WmoHeader& operator=(WmoHeader&&) noexcept;
|
|
|
|
bool operator==(const WmoHeader& o) const;
|
|
|
|
[[nodiscard]] std::string sequence_number() const;
|
|
[[nodiscard]] std::string data_type() const;
|
|
[[nodiscard]] std::string geographic_designator() const;
|
|
[[nodiscard]] std::string bulletin_id() const;
|
|
[[nodiscard]] std::string icao() const;
|
|
[[nodiscard]] std::string date_time() const;
|
|
[[nodiscard]] std::string bbb_indicator() const;
|
|
[[nodiscard]] std::string product_category() const;
|
|
[[nodiscard]] std::string product_designator() const;
|
|
|
|
/**
|
|
* @brief Get the WMO date/time
|
|
*
|
|
* Gets the WMO date/time. Uses the optional date hint provided via
|
|
* SetDateHint(std::chrono::year_month). If the date hint has not been
|
|
* provided, the endTimeHint parameter is required.
|
|
*
|
|
* @param [in] endTimeHint The optional end time bounds to provide. This is
|
|
* ignored if a date hint has been provided to determine an absolute date.
|
|
*/
|
|
[[nodiscard]] std::chrono::sys_time<std::chrono::minutes> GetDateTime(
|
|
std::optional<std::chrono::system_clock::time_point> endTimeHint =
|
|
std::nullopt);
|
|
|
|
/**
|
|
* @brief Parse a WMO header
|
|
*
|
|
* @param [in] is The input stream to parse
|
|
*/
|
|
bool Parse(std::istream& is);
|
|
|
|
/**
|
|
* @brief Provide a date hint for the WMO parser
|
|
*
|
|
* The WMO header contains a date/time in the format DDHHMM. The year and
|
|
* month must be derived using another source. The date hint provides the
|
|
* additional context required to determine the absolute product time.
|
|
*
|
|
* This function will update any absolute date/time already calculated, or
|
|
* affect the calculation of a subsequent absolute date/time.
|
|
*
|
|
* @param [in] dateHint The date hint to provide the WMO header parser
|
|
*/
|
|
void SetDateHint(std::chrono::year_month dateHint);
|
|
|
|
private:
|
|
std::unique_ptr<WmoHeaderImpl> p;
|
|
};
|
|
|
|
} // namespace scwx::awips
|