/elec/propeller-clock

To get this branch, use:
bzr branch http://bzr.ed.am/elec/propeller-clock

« back to all changes in this revision

Viewing changes to src/time.h

  • Committer: Dan
  • Date: 2011-11-03 00:18:13 UTC
  • Revision ID: dan@waxworlds.org-20111103001813-gwefcqb2m5mk1ye2
Added Notes

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/time.h
1
 
/*
2
 
 * time.h
3
 
 *
4
 
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
5
 
 *
6
 
 * This file is part of propeller-clock (hereafter referred to as "this
7
 
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
8
 
 * information.
9
 
 *
10
 
 * This program is free software: you can redistribute it and/or modify
11
 
 * it under the terms of the GNU Lesser General Public License as published
12
 
 * by the Free Software Foundation, either version 3 of the License, or
13
 
 * (at your option) any later version.
14
 
 *
15
 
 * This program is distributed in the hope that it will be useful,
16
 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17
 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 
 * GNU Lesser General Public License for more details.
19
 
 *
20
 
 * You should have received a copy of the GNU Lesser General Public License
21
 
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
 
 */
23
 
#ifndef _TIME_H_
24
 
#define _TIME_H_
25
 
 
26
 
 
27
 
class Time
28
 
{
29
 
public:
30
 
 
31
 
        /**
32
 
         * Get singleton instance.
33
 
         *
34
 
         * @return instance
35
 
         */
36
 
        static Time &get_instance();
37
 
 
38
 
        /**
39
 
         * Get year.
40
 
         *
41
 
         * @return year
42
 
         */
43
 
        int get_year();
44
 
 
45
 
        /**
46
 
         * Get month.
47
 
         *
48
 
         * @return month, 1 to 12
49
 
         */
50
 
        int get_month();
51
 
 
52
 
        /**
53
 
         * Get month name.
54
 
         *
55
 
         * @return month name
56
 
         */
57
 
        const char *get_month_name();
58
 
 
59
 
        /**
60
 
         * Get day.
61
 
         *
62
 
         * @return date, 1 to 31
63
 
         */
64
 
        int get_day();
65
 
 
66
 
        /**
67
 
         * Get number suffix.
68
 
         *
69
 
         * @param number
70
 
         * @return suffix
71
 
         */
72
 
        const char *get_day_suffix();
73
 
 
74
 
        /**
75
 
         * Get hours.
76
 
         *
77
 
         * @return hours, 0 to 23
78
 
         */
79
 
        int get_hours();
80
 
 
81
 
        /**
82
 
         * Get minutes.
83
 
         *
84
 
         * @return minutes, 0 to 59
85
 
         */
86
 
        int get_minutes();
87
 
 
88
 
        /**
89
 
         * Get seconds.
90
 
         *
91
 
         * @return seconds, 0 to 59
92
 
         */
93
 
        int get_seconds();
94
 
 
95
 
        /**
96
 
         * Update the time.
97
 
         */
98
 
        void update();
99
 
 
100
 
protected:
101
 
 
102
 
        Time();
103
 
 
104
 
        /** year */
105
 
        int _year;
106
 
 
107
 
        /** month */
108
 
        int _month;
109
 
 
110
 
        /** day */
111
 
        int _day;
112
 
 
113
 
        /** hours */
114
 
        int _hours;
115
 
 
116
 
        /** minutes */
117
 
        int _minutes;
118
 
 
119
 
        /** seconds */
120
 
        int _seconds;
121
 
 
122
 
private:
123
 
 
124
 
        /** probe the real-time clock device */
125
 
        void probe_rtc();
126
 
 
127
 
        /** milliseconds at last update */
128
 
        unsigned long _last_millis;
129
 
 
130
 
        /** milliseconds carries over from last update */
131
 
        unsigned long _carry;
132
 
 
133
 
};
134
 
 
135
 
 
136
 
#endif _TIME_H_