MeVis/Foundation/Sources/MLUtilities/mlDateTime.h

Go to the documentation of this file.

// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
#ifndef __mlDateTime_H
#define __mlDateTime_H

//ML-includes
#ifndef __mlUtilsSystem_H
#include "mlUtilsSystem.h"
#endif
#ifndef __mlSystemIncludes_H
#include "mlSystemIncludes.h"
#endif


ML_UTILS_START_NAMESPACE


//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
class ML_UTILS_EXPORT DateTime
{

public:
  
  typedef MLint32  DateTimeIntType;
  typedef MLdouble DateTimeFloatType;
  
  
  //------------------------------------------------------

  //------------------------------------------------------

  // Constructors

  DateTime();
  DateTime(const DateTime &dt);
  DateTime(DateTimeIntType yearV,     DateTimeIntType monthV,      DateTimeIntType dayV, 
           DateTimeIntType hourV = 0, DateTimeIntType minuteV = 0, DateTimeFloatType secondV = 0);
  DateTime(const char* dtString, const char* format = 0);
  DateTime(DateTimeIntType linearDaysV, DateTimeFloatType linearSecondsV);



  //------------------------------------------------------

  //------------------------------------------------------

  // All set methods return \c true if given date is valid.
  // Invalid dates are converted to valid dates, so the
  // return value may be ignored.

  DateTime &operator = (const DateTime &dt);

  // Sets both date and time portion.
  bool set(DateTimeIntType yearV,     DateTimeIntType monthV,      DateTimeIntType dayV, 
           DateTimeIntType hourV = 0, DateTimeIntType minuteV = 0, DateTimeFloatType secondV = 0);
  bool set(const char *dtString, const char *format = 0);
  bool set(DateTimeIntType linDaysV, DateTimeFloatType linSecondsV);

  // Sets date and time portion independently.
  bool setYMD(DateTimeIntType yearV, DateTimeIntType monthV,  DateTimeIntType dayV);
  bool setHMS(DateTimeIntType hourV, DateTimeIntType minuteV, DateTimeFloatType secondV);

  // Sets to current date/time.
  DateTime &now();



  //------------------------------------------------------

  //------------------------------------------------------

  void get(DateTimeIntType *yearV,     DateTimeIntType *monthV,      DateTimeIntType *dayV,
           DateTimeIntType *hourV = 0, DateTimeIntType *minuteV = 0, DateTimeFloatType *secondV = 0) const;
  void get(char *dtString, const char *format = 0) const;
  
  void getYMD(DateTimeIntType *yearV, DateTimeIntType *monthV,  DateTimeIntType *dayV) const;
  void getHMS(DateTimeIntType *hourV, DateTimeIntType *minuteV, DateTimeFloatType *secondV) const;

  DateTimeIntType year() const;
  DateTimeIntType month() const;
  DateTimeIntType day() const;
  DateTimeIntType hour() const;
  DateTimeIntType minute() const;
  DateTimeFloatType second() const;

  // Get day within year in the range 0..364(365)
  DateTimeIntType dayInYear() const;

  // Get linear day and seconds counters.
  inline DateTimeIntType linearDays() const { return _ldays; }
  inline DateTimeFloatType linearSeconds() const { return _lseconds; }

  // Test for zero date/time.
  // Returns NULL if date is zero. Returned pointer is not intended to be referenced.
  operator void *() const;   // Return NULL if date is zero
  bool operator !() const;   // Return true if date is zero



  //------------------------------------------------------

  //------------------------------------------------------

  // Adds given number of days (subtract if days < 0).
  void addDays(DateTimeIntType daysV);

  // Adds given number of days (subtract if days < 0).
  // Fractions of a day are allowed.
  void addDays(DateTimeFloatType daysV);

  // Adds given number of seconds (subtract if seconds < 0).
  void addSeconds(DateTimeFloatType secondsV);

  // Computes time passed since time point \p dateTime, giving the result
  // in days and fractions of a day.
  DateTimeFloatType daysSince(const DateTime &dateTime) const;

  // Computes time passed since time point \p dateTime, giving the result
  // in seconds and fractions of a second.
  DateTimeFloatType secondsSince(const DateTime &dateTime) const;



  //------------------------------------------------------

  //------------------------------------------------------

  bool operator == (const DateTime &dt) const;
  bool operator != (const DateTime &dt) const;
  bool operator <  (const DateTime &dt) const;
  bool operator <= (const DateTime &dt) const;
  bool operator >= (const DateTime &dt) const;
  bool operator >  (const DateTime &dt) const;



  //------------------------------------------------------

  //------------------------------------------------------

  // Tests date/time specification for validity.
  static bool validYMD(DateTimeIntType yearV, DateTimeIntType monthV,  DateTimeIntType dayV);
  static bool validHMS(DateTimeIntType hourV, DateTimeIntType minuteV, DateTimeFloatType secondV);

  // Returns number of days for given month.
  static DateTimeIntType daysOfMonth(DateTimeIntType monthV, DateTimeIntType yearV);

  // Returns number of days for given year.
  static DateTimeIntType daysOfYear(DateTimeIntType yearV);

  // Returns \c true if given year is a leap year.
  static bool isLeapYear(DateTimeIntType yearV);

  // Returns number of days for current month.
  DateTimeIntType daysOfMonth() const;

  // Returns number of days for current year.
  DateTimeIntType daysOfYear() const;

  // Returns \c true if current year is a leap year.
  bool isLeapYear() const;


protected:


  //------------------------------------------------------

  //------------------------------------------------------

  // Make sure seconds counter is in the range 0..seconds_per_day
  void normalize();



private:


  //------------------------------------------------------

  //------------------------------------------------------

  DateTimeIntType _ldays;
  DateTimeFloatType _lseconds;


  
#ifdef ML_DEPRECATED
  

  
public:
  
  typedef MLint32  DTIType;
  typedef MLdouble DTFType;  
  inline ML_DEPRECATED DateTimeIntType linDays() const { return linearDays(); }
  inline ML_DEPRECATED DateTimeFloatType linSeconds() const { return linearSeconds(); }
  
  
#endif // ML_DEPRECATED
    
};

ML_UTILS_END_NAMESPACE


//-----------------------------------------------------------------------------------
//   Stream output for std::ostream
//-----------------------------------------------------------------------------------
namespace std {

//-----------------------------------------------------------------------------------
//   Stream output for std::ostream
//-----------------------------------------------------------------------------------
  inline ostream& operator<<(ostream& s, const ML_UTILS_NAMESPACE::DateTime &dt)
  {
    s << dt.year()   << ":" 
      << dt.month()  << ":" 
      << dt.day()    << ":" 
      << dt.hour()   << ":"
      << dt.minute() << ":"
      << dt.second(); 
    return s;
  }
}

#endif // __mlDateTime_H