date.h

Go to the documentation of this file.
00001 /*
00002  * date.h
00003  *
00004  * Copyright (c) 2003 Thomas A. Vaughan
00005  * All rights reserved.
00006  *
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *     * Redistributions of source code must retain the above copyright
00011  *       notice, this list of conditions and the following disclaimer.
00012  *     * Redistributions in binary form must reproduce the above copyright
00013  *       notice, this list of conditions and the following disclaimer in the
00014  *       documentation and/or other materials provided with the distribution.
00015  *     * Neither the name of the <organization> nor the
00016  *       names of its contributors may be used to endorse or promote products
00017  *       derived from this software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
00020  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00021  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00022  * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
00023  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00024  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00025  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00026  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00028  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  *
00030  *
00031  * Basic date functions.  The fact that I have to write these is ridiculous.
00032  */
00033 
00034 #ifndef WAVEPACKET_UTIL_DATE_H__
00035 #define WAVEPACKET_UTIL_DATE_H__
00036 
00037 
00038 // includes --------------------------------------------------------------------
00039 #include "common/common.h"
00040 
00041 
00042 /// \ingroup util
00043 /*@{*/
00044 
00045 /*
00046  * Get numeric value for month string (1-12, 0 on error)
00047  */
00048 int GetMonthFromString(IN const char * month) throw();
00049 
00050 
00051 /*
00052  * Get string displayable date
00053  */
00054 void getDisplayableDateFromNetTime(IN long time, OUT std::string& display);
00055 const char * getDateString(IN long timestamp);
00056 void getDateStringFromNetTime(IN long time, OUT std::string& display);
00057 long getNetTimeFromDateString(IN const char * date) throw();
00058 
00059 /*
00060  * Get day-of-week index (0 = Sunday, 1 = Monday, 2 = Tuesday, etc.)
00061  */
00062 int getWeekdayFromNetTime(IN long time) throw();
00063 const char * GetWeekday(IN int weekday_index) throw();
00064 const char * GetMonth(IN int month_index) throw();
00065 
00066 
00067 /*
00068  * time buckets
00069  *
00070  * NOTE: buckets using GMT, not PST or any other timezone!
00071  */
00072 
00073 long getDayBucket(IN long timestamp) throw();
00074 long getWeekBucket(IN long timestamp) throw();
00075 long getMonthBucket(IN long timestamp) throw();
00076 long getYearBucket(IN long timestamp) throw();
00077 
00078 std::string getDayBucketName(IN long day_bucket);
00079 std::string getWeekBucketName(IN long week_bucket);
00080 std::string getMonthBucketName(IN long month_bucket);
00081 std::string getYearBucketName(IN long year_bucket);
00082 
00083 #endif  // WAVEPACKET_UTIL_DATE_H__
00084