---

FireTimer.h File Reference

Facility for storing and updating simulation clock. More...

#include <stdlib.h>
#include "Err.h"

Go to the source code of this file.

Compounds
struct	FireTimer_
Defines
#define	FIRE_TIMER_SECS_PER_MIN   (60)
	number of seconds per minute. More...
#define	FIRE_TIMER_SECS_PER_HOUR   (3600)
	number of seconds per hour. More...
#define	FIRE_TIMER_SECS_PER_DAY   ((FIRE_TIMER_SECS_PER_HOUR) * 24)
	number of seconds in a day. More...
#define	FIRE_TIMER_MIN_HOUR_DAY   (0)
	minimum hour in a day. More...
#define	FIRE_TIMER_MAX_HOUR_DAY   (23)
	maximum hour in a day. More...
#define	FIRE_TIMER_MIN_MO_YEAR   (1)
	minimum month in a year. More...
#define	FIRE_TIMER_MAX_MO_YEAR   (12)
	maximumm month in a year. More...
#define	FIRE_TIMER_HOUR_TO_SECS(hr)    ((hr) * FIRE_TIMER_SECS_PER_HOUR)
	returns the number of seconds in the hour supplied as argument. More...
#define	FIRE_TIMER_MIN_TO_SECS(min)    ((min) * FIRE_TIMER_SECS_PER_MIN)
	returns the number of hours in the seconds supplied as argument. More...
#define	FIRE_TIMER_SECS_TO_MIN(secs)    ((secs) / FIRE_TIMER_SECS_PER_MIN)
	returns the number of minutes in the seconds supplied as argument. More...
#define	FIRE_TIMER_SECS_TO_END_HOUR(secs)    (FIRE_TIMER_SECS_PER_HOUR - (secs))
	returns the number of seconds remaining in the hour. More...
#define	FIRE_TIMER_GET_MILITARY_TIME(ft)    ((((ft)->sim_cur_hr) * 100) + (FIRE_TIMER_SECS_TO_MIN((ft)->sim_cur_secs) % 60))
	returns a four digit military-time style representation of the current time. More...
Typedefs
typedef struct FireTimer_	FireTimer

---

Detailed Description

Facility for storing and updating simulation clock.

See also:

Check the config file documentation

Author(s):

Marco Morais

Date:

2000-2001

HFire (Highly Optmized Tolerance Fire Spread Model) Library Copyright (C) 2001 Marco Morais

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Definition in file FireTimer.h.

---

Define Documentation

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

returns a four digit military-time style representation of the current time. Definition at line 152 of file FireTimer.h. Referenced by FireExportFireIDPng(), and FireExportIgLocsTxtFile().

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

returns the number of seconds in the hour supplied as argument. Definition at line 127 of file FireTimer.h. Referenced by InitFireTimer().

#define FIRE_TIMER_MAX_HOUR_DAY   (23)

maximum hour in a day. Definition at line 63 of file FireTimer.h.

#define FIRE_TIMER_MAX_MO_YEAR   (12)

maximumm month in a year. Definition at line 73 of file FireTimer.h.

#define FIRE_TIMER_MIN_HOUR_DAY   (0)

minimum hour in a day. Definition at line 58 of file FireTimer.h.

#define FIRE_TIMER_MIN_MO_YEAR   (1)

minimum month in a year. Definition at line 68 of file FireTimer.h.

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

returns the number of hours in the seconds supplied as argument. Definition at line 137 of file FireTimer.h.

#define FIRE_TIMER_SECS_PER_DAY   ((FIRE_TIMER_SECS_PER_HOUR) * 24)

number of seconds in a day. Definition at line 53 of file FireTimer.h.

#define FIRE_TIMER_SECS_PER_HOUR   (3600)

number of seconds per hour. Definition at line 48 of file FireTimer.h.

#define FIRE_TIMER_SECS_PER_MIN   (60)

number of seconds per minute. Definition at line 43 of file FireTimer.h.

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

returns the number of seconds remaining in the hour. Definition at line 147 of file FireTimer.h.

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

Definition at line 132 of file FireTimer.h.

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

returns the number of minutes in the seconds supplied as argument. Definition at line 142 of file FireTimer.h.

---

Typedef Documentation

typedef struct FireTimer_ FireTimer

Type name for FireTimer_ See also: For a list of members goto FireTimer_ Definition at line 84 of file FireTimer.h.

---