annotate C++/Date.h @ 178:2bfe43b85d7f

Add dates
author David Demelier <markand@malikania.fr>
date Sat, 21 Sep 2013 15:08:53 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
178
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * Date.h -- date and time manipulation
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2011, 2012, 2013 David Demelier <markand@malikania.fr>
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef _DATE_H_
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define _DATE_H_
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <cstdint>
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 #include <ctime>
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 #include <string>
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 struct Date
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 {
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 time_t m_timestamp; //! time epoch
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 Date();
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 Date(time_t timestamp);
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 ~Date();
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 /**
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 * Get the timestamp.
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 *
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 * @return the timestamp
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 */
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 time_t getTimestamp() const;
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 /**
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 * Format the current that in the specified format,
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 * see strftime(3) for patterns.
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 *
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 * @param format the format
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 * @return the date formated
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 */
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 std::string format(const std::string &format);
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 };
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
50
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 bool operator==(const Date &, const Date &);
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 bool operator<=(const Date &, const Date &);
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
2bfe43b85d7f Add dates
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 #endif // !_DATE_H_