DateTime.h

Go to the documentation of this file.

/**
* @file DateTime.h
* @brief Date / Time functions
*
* @author LMI Technologies
*/

#ifndef _DateTime_h
#define _DateTime_h

#include "Windows.h"
#include <string>

using namespace std;

/**
Standard date format
*/
enum eDateFormat
{
   DateFormat_Short,                      /**< Short format */
   DateFormat_Long,                       /**< Long format  */          
};

/**
Standard time format
*/
enum eTimeFormat
{
   TimeFormat_Short,                      /**< Short format */             
   TimeFormat_Long,                       /**< Long format  */
};

#define DATE_TIME_BUFFER_SIZE 512

/**
DateTime class
*/
class CDateTime
{
public:

   /**
   Standard constructor
   */
   CDateTime();

   /**
   Constructor with date 
   
   @param dwDate  Date 
   */
   CDateTime(DWORD dwDate);

   /**
   Constructor with date time
   
   @param ulDateTime Date time
   */
   CDateTime(ULONGLONG ulDateTime);

   /**
   Constructor with year, month, day
   
   @param wYear      Year
   @param wMonth  Month
   @param wDay    Day
   */
   CDateTime(WORD wYear, WORD wMonth, WORD wDay);

   /**
   Constructor with year, month, day, hour, minute, second, hundredth second
   
   @param wYear   Year
   @param wMonth  Month
   @param wDay    Day
   @param wHour   Hour
   @param wMin    Minute
   @param wSec    Second
   @param wSec100 Hundredth second
   */
   CDateTime(WORD wYear, WORD wMonth, WORD wDay, WORD wHour, WORD wMin, WORD wSec = 0, WORD wSec100 = 0);

   /**
   Initialize
   */
   void Initialize();

   /**
   Initialize with date
   
   @param dwDate  Date
   */
   void Initialize(DWORD dwDate);

   /**
   Initialize with date time
   
   @param ulDateTime Date time
   */
   void Initialize(ULONGLONG ulDateTime);

   /**
   Initialize with year, month, day
   
   @param wYear      Year
   @param wMonth  Month
   @param wDay    Day
   */
   void Initialize(WORD wYear, WORD wMonth, WORD wDay);

   /**
   Initialize with year, month, day, hour, minute, second, hundredth second
   
   @param wYear   Year
   @param wMonth  Month
   @param wDay    Day
   @param wHour   Hour
   @param wMin    Minute
   @param wSec    Second
   @param wSec100 Hundredth second
   */
   void Initialize(WORD wYear, WORD wMonth, WORD wDay, WORD wHour, WORD wMin, WORD wSec = 0, WORD wSec100 = 0);

   /**
   Get day
   */
   WORD GetDay()
   {
      return m_DateTime.wDay;
   };

   /**
   Get Month
   */
   WORD GetMonth()
   {
      return m_DateTime.wMonth;
   };

   /**
   Get year
   */
   WORD GetYear()
   {
      return m_DateTime.wYear;
   };

   /**
   Get hour
   */
   WORD GetHour()
   {
      return m_DateTime.wHour;
   };

   /**
   Get minute
   */
   WORD GetMinute()
   {
      return m_DateTime.wMinute;
   };

   /**
   Get second
   */
   WORD GetSecond()
   {
      return m_DateTime.wSecond;
   };

   /**
   Get hundredth second
   */
   WORD GetHundredthSecond()
   {
      return (WORD)(m_DateTime.wMilliseconds / 10);
   };

   /**
   Date as string
   
   @param Format Pre-defined format
   @return Date as string
   */
   wstring DateString(eDateFormat Format);

   /**
   Date as string
   
   @param stFormat User-defined format
   @return Date as string
   */
   wstring DateString(wstring stFormat);

   /**
   Time as string
   
   @param Format Pre-defined format
   @return Time as string
   */
   wstring TimeString(eTimeFormat Format);

   /**
   Time as string
   
   @param stFormat User-defined format
   @return Time as string
   */
   wstring TimeString(wstring stFormat);

   /**
   Is year a leap year
   
   @param wYear Year
   @return Is leap year
   */
   static bool IsLeapYear(WORD wYear);

   /**
   Get current date time
   */
   static CDateTime Now();

   /**
   Convert DWORD to Date time object (time is unconsidered)
   
   @param dwDate Date
   @return new DateTime object
   */
   static CDateTime DateFromBinary(DWORD dwDate);

   /**
   Convert  Date time object to DWORD (time is unconsidered)
   
   @param DateTime DateTime object
   @return DateTime as DWORD
   */
   static DWORD DateAsBinary(CDateTime& DateTime); 

   /**
   Convert Date time to standard string(time is unconsidered)
   
   @param DateTime DateTime object
   @return DateTime as string
   */
   static wstring DateAsStandardString(CDateTime& DateTime);

   /**
   Convert standard string to Date time object to DWORD (time is unconsidered)
   
   @param stDate  Date as standard string 
   @param Date    Output date
   @return Success
   */
   static bool DateFromStandardString(wstring stDate, CDateTime& Date);

   /**
   Convert standard string to Date time object to DWORD
   
   @param stDateTime Date and time as standard string
   @param DateTime      Output date
   @return Success
   */
   static bool DateTimeFromStandardString(wstring stDateTime, CDateTime& DateTime);

   /**
   Convert ULONGLONG to DateTime object (time is unconsidered)
   
   @param ulDateTime Date as ULONGLONG
   @return new DateTime object
   */
   static CDateTime DateTimeFromBinary(ULONGLONG ulDateTime);

   /**
   Convert DateTime object to ULONGLONG (time is unconsidered)
   
   @param DateTime Date Time
   @return DateTime as ULONGLONG
   */
   static ULONGLONG DateTimeAsBinary(CDateTime& DateTime);

    /**
    Convert DateTime object to standard wide string (time is unconsidered)

    @param DateTime Date Time
    @return DateTime as string
    */
    static wstring DateTimeAsStandardString(CDateTime& DateTime);

    /**
    Convert DateTime object to standard string (time is unconsidered)

    @param DateTime Date Time
    @return DateTime as string
    */
    static string DateTimeAsStandardStringA(CDateTime& DateTime);

   /**
   Convert DateTime object to double
   
   @param DateTime Date Time
   @return DateTime as double
   */
   static double DateTimeAsDouble(CDateTime& DateTime);

   /**
   Copy operator
   */
   CDateTime& operator =(const CDateTime& DateTime);

private:

   // Numbers of days in month
   WORD DaysOfMonth(WORD wYear, WORD wMonth);

   // Date from a DWORD
   void DateFromDWord(DWORD dwDate);

   // Date as DWORD
   DWORD DateAsDWord();

   /// Date time from ULONGLONG
   void DateTimeFromULL(ULONGLONG ulDateTime);

   // Date time as ULONGLONG
   ULONGLONG DateTimeAsULL();

   SYSTEMTIME m_DateTime;
   wchar_t m_szBuffer[DATE_TIME_BUFFER_SIZE + 1];
};

#endif // _DateTime_h