DateTime.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Nico Pfeifer $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/CONCEPT/HashUtils.h>
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/OpenMSConfig.h>
 
#include <functional>
#include <memory> // unique_ptr
#include <string>
 
// foward declarations
class QDateTime;
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI DateTime
  {
public:
 
    DateTime();
 
    DateTime(const DateTime& date);
 
    DateTime(DateTime&&) noexcept;
 
    DateTime& operator=(const DateTime& source);
 
    DateTime& operator=(DateTime&&) & noexcept;
 
    ~DateTime();
 
    bool operator==(const DateTime& rhs) const;
 
    bool operator!=(const DateTime& rhs) const;
 
    bool operator<(const DateTime& rhs) const;
 
    void setDate(const String& date);
 
    void setTime(const String& date);
 
    void setDate(UInt month, UInt day, UInt year);
 
    void setTime(UInt hour, UInt minute, UInt second);
 
    void set(UInt month, UInt day, UInt year, UInt hour, UInt minute, UInt second);
 
    void get(UInt& month, UInt& day, UInt& year, UInt& hour, UInt& minute, UInt& second) const;
 
    void getDate(UInt& month, UInt& day, UInt& year) const;
 
    String getDate() const;
 
    void getTime(UInt& hour, UInt& minute, UInt& second) const;
 
    // add @param[in] s seconds to date time
    DateTime& addSecs(int s);
 
    String getTime() const;
 
    static DateTime now();
 
    bool isValid() const;
 
    bool isNull() const;
 
    void clear();
 
    /* @brief Returns a string representation of the DateTime object.
       @param[in] format "yyyy-MM-ddThh:mm:ss" corresponds to ISO 8601 and should be preferred.
    */
    String toString(const std::string& format = "yyyy-MM-ddThh:mm:ss") const;
 
    /* @brief Creates a DateTime object from string representation.
       @param[in] format "yyyy-MM-ddThh:mm:ss" corresponds to ISO 8601 and should be preferred.
    */
      static DateTime fromString(const std::string& date, const std::string& format = "yyyy-MM-ddThh:mm:ss");
 
      String get() const;
 
      void set(const String& date);
 
    private:
      std::unique_ptr<QDateTime> dt_; // use PImpl, to avoid costly #include
  };
 
} // namespace OpenMS
 
// Hash function specialization for DateTime
namespace std
{
  template<>
  struct hash<OpenMS::DateTime>
  {
    std::size_t operator()(const OpenMS::DateTime& dt) const noexcept
    {
      // Hash the date/time components including milliseconds to match operator==
      // (which compares the underlying QDateTime including milliseconds)
      // Use toString with millisecond format and convert to std::string for hashing
      std::string datetime_str = dt.toString("yyyy-MM-ddThh:mm:ss.zzz");
      return OpenMS::fnv1a_hash_string(datetime_str);
    }
  };
} // namespace std