XLDateTime.hpp

Go to the documentation of this file.

#ifndef OPENXLSX_XLDATETIME_HPP
#define OPENXLSX_XLDATETIME_HPP
 
#ifdef _MSC_VER
#    pragma warning(push)
#    pragma warning(disable : 4251)
#    pragma warning(disable : 4275)
#endif
 
// ===== External Includes ===== //
#include <chrono>
#include <ctime>
#include <string>
 
// ===== OpenXLSX Includes ===== //
#include "OpenXLSX-Exports.hpp"
#include "XLException.hpp"
 
namespace OpenXLSX
{
    class OPENXLSX_EXPORT XLDateTime
    {
    public:
        XLDateTime();
 
        explicit XLDateTime(double serial);
 
        explicit XLDateTime(const std::tm& timepoint);
 
        explicit XLDateTime(time_t unixtime);
 
        explicit XLDateTime(const std::chrono::system_clock::time_point& timepoint);
 
        // Rule of Zero: All copy/move operations are handled by the compiler
        // as the class only contains a single primitive double (m_serial).
        XLDateTime(const XLDateTime& other)                = default;
        XLDateTime(XLDateTime&& other) noexcept            = default;
        ~XLDateTime()                                      = default;
        XLDateTime& operator=(const XLDateTime& other)     = default;
        XLDateTime& operator=(XLDateTime&& other) noexcept = default;
 
        [[nodiscard]] static XLDateTime now();
 
        [[nodiscard]] static XLDateTime fromString(const std::string& dateString, const std::string& format = "%Y-%m-%d %H:%M:%S");
 
        [[nodiscard]] std::string toString(const std::string& format = "%Y-%m-%d %H:%M:%S") const;
 
        XLDateTime& operator=(double serial);
 
        XLDateTime& operator=(const std::tm& timepoint);
 
        template<typename T, typename = std::enable_if_t<std::is_floating_point_v<T>>>
        operator T() const    // NOLINT
        { return static_cast<T>(serial()); }
 
        operator std::tm() const;    // NOLINT
 
        [[nodiscard]] std::chrono::system_clock::time_point chrono() const;
 
        [[nodiscard]] double serial() const;
 
        [[nodiscard]] std::tm tm() const;
 
    private:
        double m_serial{1.0}; 
    };
}    // namespace OpenXLSX
 
#ifdef _MSC_VER
#    pragma warning(pop)
#endif
 
#endif    // OPENXLSX_XLDATETIME_HPP