mi32/datetime.h

Go to the documentation of this file.

#ifndef INC_MI32_DATETIME_H
#define INC_MI32_DATETIME_H

#ifndef INC_MI32_MISTRING_H
#include <mi32/mistring.h>
#endif

#ifndef  INC_TIME_H
#include <time.h>
#define  INC_TIME_H
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward declarations.
struct RVCDATETIME;
#ifdef WIN32
struct _SYSTEMTIME;
struct _FILETIME;
#endif
#endif


#if defined(MISYSTEMDLL)
   #define CLASSLIBEXPORT MI_DLLCLASSEXPORT
#else
   #define CLASSLIBEXPORT MI_DLLCLASSIMPORT
#endif

class CLASSLIBEXPORT DATETIME {
   public:
      enum FORMAT {
         FORMAT_ISO8601_Basic =     0,    
         FORMAT_ISO8601_Extended =  1,    
         FORMAT_XML_dateTime =      2,    
         FORMAT_XML_date =          3,    
         FORMAT_XML_time =          4,    
         FORMAT_RFC822 =            5,    
         FORMAT_Simple =            6,    
         FORMAT_YYYYMMDD_HHMMSS =   7,    
         FORMAT_Job =               FORMAT_YYYYMMDD_HHMMSS,    
         };
         
      enum TIME {
         TIME_Uninitialized = 0,
         TIME_CurrentLocal = 1,
         TIME_CurrentUTC = 2
         };

      DATETIME (
         );

      DATETIME (
         const DATETIME& rhs
         );

      DATETIME (
         TIME value
         );

      DATETIME (
         int year,         
         int month,        
         int day           
         );

      DATETIME (
         int year,         
         int month,        
         int day,          
         int hour,
         int min,
         int sec,
         bool bIsLocal     
         );

      DATETIME (
         const RVCDATETIME& rhs
         );

      DATETIME (
         const struct tm& rhs,
         bool bIsLocal        
         );

   #ifdef WIN32
      DATETIME (
         const struct _SYSTEMTIME& rhs,
         bool bIsLocal        
         );
   #endif

   #ifdef WIN32
      DATETIME (
         const struct _FILETIME& rhs,
         bool bIsLocal        
         );
   #endif

      explicit DATETIME (
         time_t value
         );

      ~DATETIME (
         );

      // Assignment operators

      DATETIME& operator= (
         const DATETIME& rhs
         );

      DATETIME& operator= (
         const RVCDATETIME& rhs
         );

      DATETIME& operator= (
         const time_t rhs
         );

      DATETIME& operator= (
         DATETIME::TIME rhs
         );

      // Comparison operators

      bool operator== (
         const DATETIME& rhs
         ) const;

      bool operator!= (
         const DATETIME& rhs
         ) const;

      bool operator< (
         const DATETIME& rhs
         ) const;

      bool operator> (
         const DATETIME& rhs
         ) const;

      bool operator<= (
         const DATETIME& rhs
         ) const;

      bool operator>= (
         const DATETIME& rhs
         ) const;


      void Clear (
         );
      
      void ConvertToLocal (
         );

      void ConvertToUTC (
         );

      void Get (
         struct tm& tm,
         bool bLocal = false     
         ) const;

      void Get (
         RVCDATETIME& dt
         ) const;

   #ifdef WIN32
      void Get (
         struct _SYSTEMTIME& st,
         bool bLocal = false     
         ) const;
   #endif

      INT32 GetYear (
         ) const;

      UINT32 GetMonth (
         ) const;

      UINT32 GetDayOfMonth (
         ) const;

      UINT32 GetHour (
         ) const;

      UINT32 GetMin (
         ) const;

      UINT32 GetSec (
         ) const;

      INT32 GetDateJulian (
         ) const;
         
      double GetDateTimeJulian (
         ) const;
         
      INT32 GetDateYYYYMMDD (
         ) const;

      MISTRING GetFormatted (
         FORMAT format,
         bool IncludeLocal          
         ) const;

      UINT64 GetNanoTime (
         ) const;

      UINT32 GetTimeOfDay (
         bool bLocal    
         ) const;

      time_t GetTimeT (
         ) const;

      UINT32 GetDayOfWeek (
         ) const;

      UINT32 GetDayOfYear (
         ) const;

      bool IsLocalTime (
         ) const;

      bool IsSet (
         ) const;

      bool IsUTCTime (
         ) const;

      bool IsValid (
         ) const;

      void Set (
         const time_t rhs
         );
         
      void Set (
         const struct tm& rhs,
         bool bIsLocal           
         );

      void Set (
         const RVCDATETIME& rhs
         );

      const MIUNICODE* Set (
         const MIUNICODE* str,
         const char* format = "%c"  
         );

   #ifdef WIN32
      void Set (
         const struct _SYSTEMTIME& rhs,
         bool bIsLocal           
         );
   #endif

   #ifdef WIN32
      void Set (
         const struct _FILETIME& rhs,
         bool bIsLocal           
         );
   #endif

      void SetBuild (
         );

      void SetCurrent (
         bool bLocalTime = true  
         );

      void SetDate (
         INT32 year,    
         UINT32 month,     
         UINT32 day        
         );

      void SetDateJulian (
         INT32 juliandate
         );
      
      void SetDateTimeJulian (
         double juliandate
         );

      void SetFormatted (
         const MISTRING& dtstr, 
         FORMAT format
         );
         
      void SetNanoTime (
         UINT64 rhs
         );

      void SetDateYYYYMMDD (
         int yyyymmdd
         );

      void SetTimeOfDay (
         UINT32 hour,
         UINT32 min,
         UINT32 sec,
         bool bIsLocal        
         );

      void SetTimeOfDay (
         UINT32 SecondsSinceMidnight,
         bool bIsLocal        
         );


      void StrfTime (
         MISTRING& str,
         const char* format,     
         bool bLocal = true      
         ) const;

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT


      void SetHour (
         UINT32 val
         );

      void SetIsLocal (
         bool bIsLocal
         );

      void SetDayOfMonth (
         UINT32 val
         );

      void SetMin (
         UINT32 val
         );

      void SetMonth (
         UINT32 val
         );

      void SetSec (
         UINT32 val
         );
      
      void SetYear (
         INT32 val
         );

      static time_t TimeTFromTM (
         const struct tm*const timeval
         );
   
      struct tm m_tm;
      bool m_bIsLocal;     
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

#undef CLASSLIBEXPORT

#endif

---