---

FireExport.h File Reference

Facility for exporting simulation output. More...

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "FireTimer.h"
#include "FireYear.h"
#include "FireProp.h"
#include "GridData.h"
#include "ChHashTable.h"
#include "KeyVal.h"
#include "Err.h"

Go to the source code of this file.

Compounds
struct	FireExport_
Defines
#define	FIRE_EXPORT_SET_FIRE_TIMER(fe, ft)    ((fe)->ft = (ft))
	sets current timer used by all export functions. More...
#define	FIRE_EXPORT_SET_FIRE_YEAR(fe, fyr)    ((fe)->fyr = (fyr))
	sets current fire year ids used by all export functions. More...
#define	FIRE_EXPORT_SET_FUELS(fe, fuels)    ((fe)->fuels = (fuels))
	sets current fuels used by all export functions. More...
#define	FIRE_EXPORT_SET_STAND_AGE(fe, std_age)    ((fe)->std_age = (std_age))
	sets current stand age used by all export functions. More...
Typedefs
typedef enum EnumFireExportFreq_	EnumFireExportFreq
typedef struct FireExport_	FireExport
Enumerations
enum	EnumFireExportFreq_ {   EnumFreqTimestep = 0,   EnumFreqDaily = 1,   EnumFreqAnnual = 2 }
	constant indicating frequency that data is output from simulation. More...

---

Detailed Description

Facility for exporting simulation output.

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 FireExport.h.

---

Define Documentation

#define FIRE_EXPORT_SET_FIRE_TIMER( fe, ft )   ((fe)->ft = (ft))

sets current timer used by all export functions. Parameters: fe   simulation FireExport structure ft   simulation FIreTimer Definition at line 127 of file FireExport.h.

#define FIRE_EXPORT_SET_FIRE_YEAR( fe, fyr )   ((fe)->fyr = (fyr))

sets current fire year ids used by all export functions. Parameters: fe   simulation FireExport structure fyr   simulation FireYear structure Definition at line 134 of file FireExport.h.

#define FIRE_EXPORT_SET_FUELS( fe, fuels )   ((fe)->fuels = (fuels))

sets current fuels used by all export functions. Parameters: fe   simulation FireExport structure fuels   simulation fuels data Definition at line 141 of file FireExport.h.

#define FIRE_EXPORT_SET_STAND_AGE( fe, std_age )   ((fe)->std_age = (std_age))

sets current stand age used by all export functions. Parameters: fe   simulation FireExport structure std_age   simulation stand age data Definition at line 148 of file FireExport.h.

---

Typedef Documentation

typedef enum EnumFireExportFreq_ EnumFireExportFreq

Type name for EnumFireExportFreq_ See also: For a list of constants goto EnumFireExportFreq_ Definition at line 83 of file FireExport.h.

typedef struct FireExport_ FireExport

Type name for FireExport_ See also: For a list of members goto FireExport_ Definition at line 88 of file FireExport.h.

---

Enumeration Type Documentation

enum EnumFireExportFreq_

constant indicating frequency that data is output from simulation. Note: EnumFreqTimestep data exported at the conclusion of every timestep (length timestep user-defined) EnumFreqDaily data exported at the conclusion of every day (0000 hours) during simulation EnumFreqAnnual data exported at the conclusion of every year during simulation Definition at line 68 of file FireExport.h.

---