---

FireTimer.h

Go to the documentation of this file.

#ifndef FireTimer_H
#define FireTimer_H

#include <stdlib.h>

#include "Err.h"
    
/*
 *********************************************************
 * DEFINES, ENUMS
 *********************************************************
 */
 
#define FIRE_TIMER_SECS_PER_MIN                         (60)
 
#define FIRE_TIMER_SECS_PER_HOUR                        (3600)

#define FIRE_TIMER_SECS_PER_DAY                         ((FIRE_TIMER_SECS_PER_HOUR) * 24)

#define FIRE_TIMER_MIN_HOUR_DAY                         (0)

#define FIRE_TIMER_MAX_HOUR_DAY                         (23)

#define FIRE_TIMER_MIN_MO_YEAR                          (1)

#define FIRE_TIMER_MAX_MO_YEAR                          (12)

/*
 *********************************************************
 * STRUCTS, TYPEDEFS
 *********************************************************
 */

typedef struct FireTimer_ FireTimer;

struct FireTimer_   {
    int sim_start_yr;                               
    int sim_start_mo;
    int sim_start_dy;                                   
    int sim_start_hr;                                   
    int sim_end_yr;
    int sim_end_mo; 
    int sim_end_dy; 
    int sim_end_hr; 
    int sim_cur_yr;
    int sim_cur_mo;
    int sim_cur_dy; 
    int sim_cur_hr; 
    int sim_cur_secs;
    };
         
/*
 *********************************************************
 * MACROS
 *********************************************************
 */

#define FIRE_TIMER_HOUR_TO_SECS(hr)                     ((hr) * FIRE_TIMER_SECS_PER_HOUR)

#define FIRE_TIMER_SECS_TO_HOUR(secs)                   ((secs) / FIRE_TIMER_SECS_PER_HOUR)

#define FIRE_TIMER_MIN_TO_SECS(min)                     ((min) * FIRE_TIMER_SECS_PER_MIN)

#define FIRE_TIMER_SECS_TO_MIN(secs)                    ((secs) / FIRE_TIMER_SECS_PER_MIN)

#define FIRE_TIMER_SECS_TO_END_HOUR(secs)               (FIRE_TIMER_SECS_PER_HOUR - (secs))

#define FIRE_TIMER_GET_MILITARY_TIME(ft)                ((((ft)->sim_cur_hr) * 100) + (FIRE_TIMER_SECS_TO_MIN((ft)->sim_cur_secs) % 60))

 
/*
 *********************************************************
 * PUBLIC FUNCTIONS
 *********************************************************
 */

FireTimer * InitFireTimer(int sim_start_yr, int sim_start_mo, int sim_start_dy, int sim_start_hr,
                          int sim_end_yr, int sim_end_mo, int sim_end_dy, int sim_end_hr);

int FireTimerIncrementSeconds(FireTimer * ft, int secs);

int FireTimerIsSimCurYearTimeExpired(FireTimer * ft);

int FireTimerIsSimTimeExpired(FireTimer * ft);

int FireTimerGetDaysInMonth(int mo);

int FireTimerGetDaysDifftime(int mo1, int dy1, int mo2, int dy2);

void FreeFireTimer(FireTimer * fs); 
 
#endif FireTimer_H      /* end of FireTimer.h */

---