OpenMS  3.0.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-2022.
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 <memory> // unique_ptr
41 #include <string>
42 
43 // foward declarations
44 class QDateTime;
45 
46 namespace OpenMS
47 {
48  class String;
49 
58  class OPENMS_DLLAPI DateTime
59  {
60 public:
61 
67  DateTime();
68 
70  DateTime(const DateTime& date);
71 
73  DateTime(DateTime&&) noexcept;
74 
76  DateTime& operator=(const DateTime& source);
77 
79  DateTime& operator=(DateTime&&) & noexcept;
80 
82  ~DateTime();
83 
85  bool operator==(const DateTime& rhs) const;
86 
88  bool operator!=(const DateTime& rhs) const;
89 
91  bool operator<(const DateTime& rhs) const;
92 
100  void setDate(const String& date);
101 
109  void setTime(const String& date);
110 
118  void setDate(UInt month, UInt day, UInt year);
119 
127  void setTime(UInt hour, UInt minute, UInt second);
128 
136  void set(UInt month, UInt day, UInt year, UInt hour, UInt minute, UInt second);
137 
143  void get(UInt& month, UInt& day, UInt& year, UInt& hour, UInt& minute, UInt& second) const;
144 
150  void getDate(UInt& month, UInt& day, UInt& year) const;
151 
157  String getDate() const;
158 
164  void getTime(UInt& hour, UInt& minute, UInt& second) const;
165 
166  // add @param s seconds to date time
167  DateTime& addSecs(int s);
168 
174  String getTime() const;
175 
177  static DateTime now();
178 
180  bool isValid() const;
181 
183  bool isNull() const;
184 
186  void clear();
187 
188  /* @brief Returns a string representation of the DateTime object.
189  @param format "yyyy-MM-ddThh:mm:ss" corresponds to ISO 8601 and should be preferred.
190  */
191  String toString(std::string format = "yyyy-MM-ddThh:mm:ss") const;
192 
193  /* @brief Creates a DateTime object from string representation.
194  @param format "yyyy-MM-ddThh:mm:ss" corresponds to ISO 8601 and should be preferred.
195  */
196  static DateTime fromString(const std::string& date, std::string format = "yyyy-MM-ddThh:mm:ss");
197 
203  String get() const;
204 
218  void set(const String& date);
219 
220  private:
221  std::unique_ptr<QDateTime> dt_; // use PImpl, to avoid costly #include
222  };
223 
224 } // namespace OPENMS
OpenMS::toString
const std::string & toString(const DriftTimeUnit value)
Types.h
OpenMS::String
A more convenient string class.
Definition: String.h:58
KDTree::operator!=
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
OpenMS::operator<
bool operator<(const MultiplexDeltaMasses &dm1, const MultiplexDeltaMasses &dm2)
OpenMS::DateTime::dt_
std::unique_ptr< QDateTime > dt_
Definition: DateTime.h:221
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::UInt
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
OpenMS::Internal::operator==
bool operator==(const IDBoostGraph::ProteinGroup &lhs, const IDBoostGraph::ProteinGroup &rhs)
OpenMS::DateTime
DateTime Class.
Definition: DateTime.h:58