OpenMS  2.8.0
DateTime.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2021.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: Nico Pfeifer $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/CONCEPT/Types.h>
38 #include <OpenMS/OpenMSConfig.h>
39 
40 #include <QtCore/QDate>
41 
42 namespace OpenMS
43 {
44  class String;
45 
54  class OPENMS_DLLAPI DateTime
55  {
56 public:
57 
64 
66  DateTime(const DateTime& date) = default;
67 
69  DateTime(DateTime&&) = default;
70 
72  DateTime& operator=(const DateTime& source);
73 
75  DateTime& operator=(DateTime&&) & noexcept;
76 
78  bool operator==(const DateTime& rhs) const;
79 
81  bool operator!=(const DateTime& rhs) const;
82 
84  bool operator<(const DateTime& rhs) const;
85 
93  void setDate(const String& date);
94 
102  void setTime(const String& date);
103 
111  void setDate(UInt month, UInt day, UInt year);
112 
120  void setTime(UInt hour, UInt minute, UInt second);
121 
129  void set(UInt month, UInt day, UInt year, UInt hour, UInt minute, UInt second);
130 
136  void get(UInt& month, UInt& day, UInt& year, UInt& hour, UInt& minute, UInt& second) const;
137 
143  void getDate(UInt& month, UInt& day, UInt& year) const;
144 
150  String getDate() const;
151 
157  void getTime(UInt& hour, UInt& minute, UInt& second) const;
158 
159  // add @param s seconds to date time
160  DateTime& addSecs(int s);
161 
167  String getTime() const;
168 
170  static DateTime now();
171 
173  bool isValid() const;
174 
176  bool isNull() const;
177 
179  void clear();
180 
181  /* @brief Returns a string representation of the DateTime object.
182  @param format "yyyy-MM-ddThh:mm:ss" corresponds to ISO 8601 and should be preferred.
183  */
184  String toString(std::string format = "yyyy-MM-ddThh:mm:ss") const;
185 
186  /* @brief Creates a DateTime object from string representation.
187  @param format "yyyy-MM-ddThh:mm:ss" corresponds to ISO 8601 and should be preferred.
188  */
189  static DateTime fromString(const std::string& date, std::string format = "yyyy-MM-ddThh:mm:ss");
190 
196  String get() const;
197 
211  void set(const String& date);
212 
213 private:
214  QDateTime dt_;
215  };
216 
217 } // namespace OPENMS
DateTime Class.
Definition: DateTime.h:55
void setDate(UInt month, UInt day, UInt year)
sets data from three integers
bool operator!=(const DateTime &rhs) const
not-equal operator
String getDate() const
Returns the date as string.
static DateTime now()
Returns the current date and time.
QDateTime dt_
Definition: DateTime.h:214
String toString(std::string format="yyyy-MM-ddThh:mm:ss") const
void setTime(const String &date)
sets time from a string
bool operator<(const DateTime &rhs) const
less operator
DateTime()
Default constructor.
String getTime() const
Returns the time as string.
static DateTime fromString(const std::string &date, std::string format="yyyy-MM-ddThh:mm:ss")
void getDate(UInt &month, UInt &day, UInt &year) const
Fills the arguments with the date.
bool isValid() const
Returns true if the date time is valid.
DateTime & operator=(const DateTime &source)
Assignment operator.
DateTime(DateTime &&)=default
Move constructor.
void set(const String &date)
Sets date and time.
DateTime & operator=(DateTime &&) &noexcept
Move assignment operator.
void setDate(const String &date)
sets date from a string
void getTime(UInt &hour, UInt &minute, UInt &second) const
Fills the arguments with the time.
bool isNull() const
return true if the date and time is null
bool operator==(const DateTime &rhs) const
equal operator
String get() const
Returns a string representation of the date and time.
void clear()
Sets the undefined date: 00/00/0000 00:00:00.
void get(UInt &month, UInt &day, UInt &year, UInt &hour, UInt &minute, UInt &second) const
Fills the arguments with the date and the time.
DateTime & addSecs(int s)
void setTime(UInt hour, UInt minute, UInt second)
sets time from three integers
DateTime(const DateTime &date)=default
Copy constructor.
void set(UInt month, UInt day, UInt year, UInt hour, UInt minute, UInt second)
sets data from six integers
A more convenient string class.
Definition: String.h:60
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47