/elec/propeller-clock

To get this branch, use:
bzr branch http://bzr.ed.am/elec/propeller-clock
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
 * time.h
 *
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
 *
 * This file is part of propeller-clock (hereafter referred to as "this
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
 * information.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef _TIME_H_
#define _TIME_H_


namespace Time
{
	/**
	 * Initialise time from store.
	 */
	void load_time();

	/**
	 * Save the time to the store.
	 */
	void save_time();

	/**
	 * Get year.
	 *
	 * @return year
	 */
	int get_year();

	/**
	 * Get month.
	 *
	 * @return month, 1 to 12
	 */
	int get_month();

	/**
	 * Get month name.
	 *
	 * @return month name
	 */
	const char *get_month_name();

	/**
	 * Get day.
	 *
	 * @return date, 1 to 31
	 */
	int get_day();

	/**
	 * Get number suffix.
	 *
	 * @param number
	 * @return suffix
	 */
	const char *get_day_suffix();

	/**
	 * Get hours.
	 *
	 * @return hours, 0 to 23
	 */
	int get_hours();

	/**
	 * Get minutes.
	 *
	 * @return minutes, 0 to 59
	 */
	int get_minutes();

	/**
	 * Get seconds.
	 *
	 * @return seconds, 0 to 59
	 */
	int get_seconds();

	/**
	 * Update the time.
	 */
	void update();

	/**
	 * Increment the hours and save the time.
	 */
	void inc_hours();

	/**
	 * Increment the minutes and save the time.
	 */
	void inc_minutes();

	/**
	 * Reset the seconds and save the time.
	 */
	void reset_seconds();

	/**
	 * Increment the year and save the time.
	 */
	void inc_year();

	/**
	 * Increment the month and save the time.
	 */
	void inc_month();

	/**
	 * Increment the day and save the time.
	 */
	void inc_day();

};


#endif //_TIME_H_