time-definitions.h

Go to the documentation of this file.

/* WOSS - World Ocean Simulation System -
 * 
 * Copyright (C) 2009 2025 Federico Guerra
 * and regents of the SIGNET lab, University of Padova
 *
 * Author: Federico Guerra - WOSS@guerra-tlc.com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */ 
 
 
#ifndef WOSS_TIME_DEFINITIONS_H
#define WOSS_TIME_DEFINITIONS_H
 
 
#include <iostream>
#include <ctime>
#include <cassert>
#include <cmath>
#include <climits>
#include <memory>
 
namespace woss {
 
  static constexpr long TIME_NOT_SET_VALUE = (LONG_MIN);
 
  class TimeReference {
 
    public:
 
    virtual ~TimeReference() = 0;
 
    virtual std::unique_ptr<TimeReference> clone() const = 0;
 
    virtual double getTimeReference() const = 0;
 
  };
 
  inline TimeReference::~TimeReference() = default;
 
  class Time {
 
    public:
 
    Time();
 
    Time( struct tm* time );
 
    Time( int day, int month, int year, int hours = 0, int mins = 0, int seconds = 1 ); 
 
    Time( const Time& copy ) = default;
 
    Time( Time&& tmp ) = default;
 
    ~Time() = default;
 
    Time& setMonth( int m ) { assert( m >= 1 && m <= 12 ); timeinfo.tm_mon = m - 1; raw_time = mktime(&timeinfo); 
                              return *this; }
 
    Time& setDay( int d ) { assert( d >= 1 && d <= 31 ); timeinfo.tm_mday = d; raw_time = mktime(&timeinfo); return *this; }
 
    Time& setYear( int y ) { assert( y >= 1900 ); timeinfo.tm_year = y - 1900; raw_time = mktime(&timeinfo); return *this; }
 
    Time& setHours( int h ) { assert( h >= 0 && h <= 23 ); timeinfo.tm_hour = h; raw_time = mktime(&timeinfo); return *this; }
 
    Time& setMinutes( int m ) { assert( m >= 0 && m <= 59 ); timeinfo.tm_min = m; raw_time = mktime(&timeinfo); return *this; }
 
    Time& setSeconds( int s ) { assert( s >= 0 && s <= 59 ); timeinfo.tm_sec = s; raw_time = mktime(&timeinfo); return *this; }
 
    static void setDebug(bool flag) { debug = flag; }
 
    bool isValid() const { return ( raw_time != TIME_NOT_SET_VALUE ); }
 
    int getMonth() const { return timeinfo.tm_mon; }
 
    int getDay() const { return timeinfo.tm_mday; }
 
    int getHours() const { return timeinfo.tm_hour; }
 
    int getYear() const { return timeinfo.tm_year; }
 
    int getMinutes() const { return timeinfo.tm_min; }
 
    int getSeconds() const { return timeinfo.tm_sec; }
 
    operator time_t() const;
 
    Time& operator=( const Time& copy ) = default;
 
    Time& operator=( Time&& tmp ) = default;
 
    friend const Time operator+( const Time& left, const time_t right );
 
    friend const Time operator-( const Time& left, const time_t right );
 
    friend double operator-( const Time& left, const Time& right );
 
    friend Time& operator+=( Time& left, time_t right );
 
    friend Time& operator-=( Time& left, time_t right );
 
    friend bool operator==( const Time& left, const Time& right );
 
    friend bool operator!=( const Time& left, const Time& right );
 
    friend bool operator>( const Time& left, const Time& right );
 
    friend bool operator<( const Time& left, const Time& right );
 
    friend bool operator<=( const Time& left, const Time& right );
 
    friend bool operator>=( const Time& left, const Time& right );
 
    friend std::ostream& operator<<( std::ostream& os, const Time& instance );
 
    protected:
 
    mutable struct tm timeinfo;
 
    time_t raw_time;
 
    static bool debug;
 
  };
 
  struct SimTime {
 
    SimTime( Time time1 = Time(), Time time2 = Time() ) : start_time(time1), end_time(time2) { }
 
    friend std::ostream& operator<<( std::ostream& os, const SimTime& instance ) {
      os << "start time = " << instance.start_time << "; end time = " << instance.end_time;
      return os;
    }
 
    Time start_time;
    
    Time end_time;
 
  };
 
  // non-inline operator declarations
  double operator-( const Time& left, const Time& right );
 
  //inline functions
  inline Time::operator time_t() const {
    return( mktime(&timeinfo) );
  }
 
  inline bool operator==( const Time& left, const Time& right ) {
    if ( &left == &right ) return true; 
    return( mktime(const_cast<tm*>(&left.timeinfo)) == mktime(const_cast<tm*>(&right.timeinfo)) );
  }
 
  inline bool operator!=( const Time& left, const Time& right ) {
    if ( &left == &right ) return false; 
    return( mktime(const_cast<tm*>(&left.timeinfo)) != mktime(const_cast<tm*>(&right.timeinfo)) );
  }
 
  inline bool operator>( const Time& left, const Time& right ) {
    if ( &left == &right ) return false; 
    return( mktime(const_cast<tm*>(&left.timeinfo)) > mktime(const_cast<tm*>(&right.timeinfo)) );
  }
 
  inline bool operator<( const Time& left, const Time& right ) {
    if ( &left == &right ) return false; 
    return( mktime(const_cast<tm*>(&left.timeinfo)) < mktime(const_cast<tm*>(&right.timeinfo)) );
  }
 
  inline bool operator<=( const Time& left, const Time& right ) {
    return( mktime(const_cast<tm*>(&left.timeinfo)) <= mktime(const_cast<tm*>(&right.timeinfo)) );
  }
 
  inline bool operator>=( const Time& left, const Time& right ) {
    return( mktime(const_cast<tm*>(&left.timeinfo)) >= mktime(const_cast<tm*>(&right.timeinfo)) );
  }
 
  inline std::ostream& operator<<( std::ostream& os, const Time& time ) {
    os << asctime(const_cast<tm*>(&time.timeinfo)) ;
    return os;
  }
 
  inline const Time operator+( const Time& left, const time_t right ) {
    time_t sum_time = mktime(const_cast<tm*>(&left.timeinfo)) + right;
    return( Time( localtime( &sum_time ) ) );
  }
 
  inline const Time operator-( const Time& left, const time_t right ) {
    time_t diff_time = mktime(const_cast<tm*>(&left.timeinfo)) - right;
    return( Time( localtime( &diff_time ) ) );
  }
 
  Time& operator+=( Time& left, time_t right );
 
  Time& operator-=( Time& left, time_t right );
 
}
 
#endif /* WOSS_TIME_DEFINITIONS_H */