DateTime.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2023.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Nico Pfeifer $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/OpenMSConfig.h>
 
#include <memory> // unique_ptr
#include <string>
 
// foward declarations
class QDateTime; 
 
namespace OpenMS
{
  class String;
 
  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 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 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 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