---

FireExport.h

Go to the documentation of this file.

#ifndef FireExport_H
#define FireExport_H

#include <stdlib.h>
#include <stdio.h>
#include <string.h>

#ifdef USING_GD

#include "FireExportImg.h"

#endif /* INCLUDES SUPPORT FOR EXPORTING IMAGES FROM SIMULATION USING GD LIBRARY */

#include "FireTimer.h"
#include "FireYear.h"
#include "FireProp.h"
#include "GridData.h"
#include "ChHashTable.h"
#include "KeyVal.h"
#include "Err.h"

/*
 *********************************************************
 * DEFINES, ENUMS
 *********************************************************
 */
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS

/* defaults for exported filenames */
#define FIRE_EXPORT_DEFAULT_FILENAME_SIZE                       (256)
#define FIRE_EXPORT_DEFAULT_TITLE_SIZE                          (40)

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

enum EnumFireExportFreq_    {
    EnumFreqTimestep    = 0,
    EnumFreqDaily       = 1,
    EnumFreqAnnual      = 2
    };
     
/*
 *********************************************************
 * STRUCTS, TYPEDEFS
 *********************************************************
 */

typedef enum EnumFireExportFreq_ EnumFireExportFreq;

typedef struct FireExport_ FireExport;

struct FireExport_  {
    EnumFireExportFreq exp_freq;
    FireTimer * ft;
    FireYear * fyr;
    GridData * fuels;
    GridData * std_age;
    int (* FireExportFireIDAscRaster)   (ChHashTable * proptbl, FireYear * fyr, FireTimer * ft);
    int (* FireExportFuelsAscRaster)    (ChHashTable * proptbl, GridData * fuels, FireTimer * ft);
    int (* FireExportStandAgeAscRaster) (ChHashTable * proptbl, GridData * std_age, FireTimer * ft);
    int (* FireExportFireIDPng)         (ChHashTable * proptbl, FireYear * fyr, FireTimer * ft);
    };
         
/*
 *********************************************************
 * MACROS
 *********************************************************
 */
 
#define FIRE_EXPORT_SET_FIRE_TIMER(fe, ft)                          ((fe)->ft = (ft))

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

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

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

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

FireExport * InitFireExport(ChHashTable * proptbl);

int FireExportSpatialData(ChHashTable * proptbl, FireExport * fe);

int FireExportInitTxtFileHeaders(ChHashTable * proptbl);

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

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

void FreeFireExport(FireExport * fe);
  
#endif FireExport_H     /* end of FireExport.h */

---