---

FireExport.c File Reference

#include "FireExport.h"

Go to the source code of this file.

Functions
FireExport*	InitFireExport (ChHashTable * proptbl)
	Initializes a FireExport structure using ChHashTable of simulation properties. More...
int	FireExportSpatialData (ChHashTable * proptbl, FireExport * fe)
	Iterates over function pointers in FireExport to generate output spatial data from simulation. More...
int	FireExportInitTxtFileHeaders (ChHashTable * proptbl)
	Inserts headers into tabular textfile output used by simulation. More...
int	FireExportIgLocsTxtFile (ChHashTable * proptbl, double rwx, double rwy, FireTimer * ft)
	Writes a single record into table of ignition locations. More...
int	FireExportSantaAnaEvtTxtFile (ChHashTable * proptbl, int duration, int year, int month, int day)
	Writes a single record into table of Santa Ana occurences. More...
void	FreeFireExport (FireExport * fe)
	Frees memory associated with FireExport structure. More...

---

Detailed Description

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.c.

---

Function Documentation

int FireExportFireIDAscRaster ( ChHashTable * proptbl, FireYear * fyr, FireTimer * ft )

Definition at line 165 of file FireExport.c.

int FireExportFuelsAscRaster ( ChHashTable * proptbl, GridData * fuels, FireTimer * ft )

Definition at line 193 of file FireExport.c.

int FireExportIgLocsTxtFile ( ChHashTable * proptbl, double rwx, double rwy, FireTimer * ft )

Writes a single record into table of ignition locations. See also: ChHashTable , FireTimer , Check the config file documentation Parameters: proptbl   ChHashTable of simulation properties rwx   real world x coordinate of ignition location rwy   real world y coordinate of ignition location ft   simulation timer stored in FireTimer Return values: ERR_SUCCESS   (0) if operation successful, an error code otherwise Note: Best use of this facility is as follows: int error_status = SomeFunctionXXX(); if ( error_status ) // something bad happened Definition at line 303 of file FireExport.c.

int FireExportInitTxtFileHeaders ( ChHashTable * proptbl )

Inserts headers into tabular textfile output used by simulation. See also: ChHashTable , Check the config file documentation Parameters: proptbl   ChHashTable of simulation properties Return values: ERR_SUCCESS   (0) if operation successful, an error code otherwise Note: Best use of this facility is as follows: int error_status = SomeFunctionXXX(); if ( error_status ) // something bad happened Definition at line 247 of file FireExport.c. Referenced by InitFireExport().

int FireExportSantaAnaEvtTxtFile ( ChHashTable * proptbl, int duration, int year, int month, int day )

Writes a single record into table of Santa Ana occurences. See also: ChHashTable , Check the config file documentation Parameters: proptbl   ChHashTable of simulation properties duration   duration of stochastically generated Santa Ana event year   year during which Santa Ana occurs month   month during which Santa Ana occurs day   day during which Santa Ana occurs Return values: ERR_SUCCESS   (0) if operation successful, an error code otherwise Note: Best use of this facility is as follows: int error_status = SomeFunctionXXX(); if ( error_status ) // something bad happened Definition at line 330 of file FireExport.c. Referenced by IsSantaAnaNowFromProps().

int FireExportSpatialData ( ChHashTable * proptbl, FireExport * fe )

Iterates over function pointers in FireExport to generate output spatial data from simulation. Simulation properties contain user-specified settings which control frequency and type of output generated. See also: ChHashTable , FireExport , Check the config file documentation Parameters: proptbl   ChHashTable of simulation properties fe   FireExport structure Return values: ERR_SUCCESS   (0) if operation successful, an error code otherwise Note: Best use of this facility is as follows: int error_status = SomeFunctionXXX(); if ( error_status ) // something bad happened Definition at line 95 of file FireExport.c.

int FireExportStandAgeAscRaster ( ChHashTable * proptbl, GridData * std_age, FireTimer * ft )

Definition at line 220 of file FireExport.c.

void FreeFireExport ( FireExport * fe )

Frees memory associated with FireExport structure. Subsequent calls to methods taking FireExport as argument will not work. See also: FireExport , Check the config file documentation Parameters: fe   ptr to FireExport Definition at line 355 of file FireExport.c. Referenced by InitFireExport().

FireExport * InitFireExport ( ChHashTable * proptbl )

Initializes a FireExport structure using ChHashTable of simulation properties. Simulation properties contain user-specified settings which control frequency and type of output generated. See also: ChHashTable , FireExport , Check the config file documentation Parameters: proptbl   ChHashTable of simulation properties Return values: FireExport   * Ptr to initialized FireExport structure Definition at line 39 of file FireExport.c.

---