xlnt
datetime.hpp
1 // Copyright (c) 2014-2022 Thomas Fussell
2 // Copyright (c) 2024 xlnt-community
3 //
4 // Permission is hereby granted, free of charge, to any person obtaining a copy
5 // of this software and associated documentation files (the "Software"), to deal
6 // in the Software without restriction, including without limitation the rights
7 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 // copies of the Software, and to permit persons to whom the Software is
9 // furnished to do so, subject to the following conditions:
10 //
11 // The above copyright notice and this permission notice shall be included in
12 // all copies or substantial portions of the Software.
13 //
14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 // THE SOFTWARE
21 //
22 // @license: http://www.opensource.org/licenses/mit-license.php
23 // @author: see AUTHORS file
24 
25 #pragma once
26 
27 #include <string>
28 
29 #include <xlnt/xlnt_config.hpp>
30 #include <xlnt/utils/calendar.hpp>
31 
32 namespace xlnt {
33 
34 struct date;
35 struct time;
36 
41 struct XLNT_API datetime
42 {
47  static datetime now();
48 
54  static datetime today();
55 
61  static datetime from_number(double number, calendar base_date);
62 
66  static datetime from_iso_string(const std::string &iso_string);
67 
71  datetime(const date &d, const time &t);
72 
76  datetime(int year_, int month_, int day_, int hour_ = 0, int minute_ = 0, int second_ = 0, int microsecond_ = 0);
77 
81  datetime() = default;
82 
87  std::string to_string() const;
88 
93  std::string to_iso_string() const;
94 
99  double to_number(calendar base_date) const;
100 
104  bool operator==(const datetime &comparand) const;
105 
111  int weekday() const;
112 
117  int get_year() const;
118 
123  int get_month() const;
124 
129  int get_day() const;
130 
135  int get_hour() const;
136 
141  int get_minute() const;
142 
147  int get_second() const;
148 
153  int get_microsecond() const;
154 
158  bool is_null() const
159  {
160  return _is_null;
161  }
162 
164 
168  int year = 0;
169 
173  int month = 0;
174 
178  int day = 0;
179 
183  int hour = 0;
184 
188  int minute = 0;
189 
193  int second = 0;
194 
198  int microsecond = 0;
199 
200 
201 private:
202 
206  bool _is_null = true;
207 };
208 
209 } // namespace xlnt
bool is_null() const
Returns whether the date is in an empty/invalid state.
Definition: datetime.hpp:158
value is a number
Enumerates the possible types a cell can be determined by it&#39;s current value.
Definition: cell.hpp:37
A time is a specific time of the day specified in terms of an hour, minute, second, and microsecond (0-999999). It can also be initialized as a fraction of a day using time::from_number.
Definition: time.hpp:38
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
value is an ISO 8601 formatted date
A datetime is a combination of a date and a time. IMPORTANT: The datetime could be in an empty/invali...
Definition: datetime.hpp:41
A date is a specific day specified in terms of a year, month, and day. It can also be initialized as ...
Definition: date.hpp:39
calendar
An enumeration of possible base dates. Dates in Excel are stored as days since this base date...
Definition: calendar.hpp:35