Main Page   Compound List   File List   Compound Members   File Members  

FireProp.h

Go to the documentation of this file.
00001 
00027 #ifndef FireProp_H
00028 #define FireProp_H
00029 
00030 #include <stdlib.h>
00031 
00032 /*
00033  *********************************************************
00034  * DEFINES, ENUMS
00035  *********************************************************
00036  */
00037 
00038 /* maximum size of any of the property keywords */
00039 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00040 
00041 #define FIRE_PROP_MAX_SIZE_KEYWORD                              (64)
00042 
00043 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
00044 
00049 enum EnumFireProp_ {
00050     PROP_LOW_BOUND  = -1,                   /* DO NOT EDIT- LOWER ENUMERATION BOUNDS */
00051     PROP_SIMSTYR    = 0,                    /*"SIMULATION_START_YEAR"*/
00052     PROP_SIMSTMO    = 1,                    /*"SIMULATION_START_MONTH"*/
00053     PROP_SIMSTDY    = 2,                    /*"SIMULATION_START_DAY"*/
00054     PROP_SIMSTHR    = 3,                    /*"SIMULATION_START_HOUR"*/
00055     PROP_SIMEDYR    = 4,                    /*"SIMULATION_END_YEAR"*/   
00056     PROP_SIMEDMO    = 5,                    /*"SIMULATION_END_MONTH"*/  
00057     PROP_SIMEDDY    = 6,                    /*"SIMULATION_END_DAY"*/        
00058     PROP_SIMEDHR    = 7,                    /*"SIMULATION_END_HOUR"*/
00059     PROP_SIMTSSEC   = 8,                    /*"SIMULATION_TIMESTEP_SECS"*/  
00060     PROP_SIMRNGSD   = 9,                    /*"SIMULATION_RAND_NUM_SEED"*/
00061     PROP_FPTYP      = 10,                   /*"FUELS_PROPS_TYPE" */
00062     PROP_FPFMD      = 11,                   /*"FUELS_PROPS_FMD_FILE"    */
00063     PROP_FPIMP      = 12,                   /*"FUELS_PROPS_FM_NUMS_IMPORT"*/
00064     PROP_FPUNB      = 13,                   /*"FUELS_PROPS_FM_NUMS_UNBURNABLE"*/
00065     PROP_ELEVFMT    = 14,                   /*"ELEV_RASTER_FORMAT"*/    
00066     PROP_ELEVMN     = 15,                   /*"ELEV_RASTER_MAIN_FILE"*/     
00067     PROP_ELEVHDR    = 16,                   /*"ELEV_RASTER_HEADER_FILE"*/   
00068     PROP_ELEVTYP    = 17,                   /*"ELEV_RASTER_TYPE"*/      
00069     PROP_SLPFMT     = 18,                   /*"SLOPE_RASTER_FORMAT"*/
00070     PROP_SLPMN      = 19,                   /*"SLOPE_RASTER_MAIN_FILE"*/    
00071     PROP_SLPHDR     = 20,                   /*"SLOPE_RASTER_HEADER_FILE"*/  
00072     PROP_SLPTYP     = 21,                   /*"SLOPE_RASTER_TYPE"*/         
00073     PROP_ASPFMT     = 22,                   /*"ASPECT_RASTER_FORMAT"*/
00074     PROP_ASPMN      = 23,                   /*"ASPECT_RASTER_MAIN_FILE"*/   
00075     PROP_ASPHDR     = 24,                   /*"ASPECT_RASTER_HEADER_FILE"*/
00076     PROP_ASPTYP     = 25,                   /*"ASPECT_RASTER_TYPE"*/        
00077     PROP_EXPFREQ    = 26,                   /*"EXPORT_FREQUENCY"*/
00078     PROP_EXPFIDDIR  = 27,                   /*"EXPORT_FIRE_ID_RASTER_DIR"*/
00079     PROP_EXPFUELDIR = 28,                   /*"EXPORT_FUELS_RASTER_DIR"*/
00080     PROP_EXPSAGEDIR = 29,                   /*"EXPORT_STAND_AGE_RASTER_DIR"*/
00081     PROP_EXPFAREAF  = 30,                   /*"EXPORT_FIRE_AREA_FILE"*/
00082     PROP_EXPFPERMF  = 31,                   /*"EXPORT_FIRE_PERIMTER_FILE"*/
00083     PROP_EXPIGLCF   = 32,                   /*"EXPORT_IGNITION_LOCS_FILE"*/
00084     PROP_EXPSANAEVF = 33,                   /*"EXPORT_SANTA_ANA_EVT_FILE"*/ 
00085     PROP_EXPFPDIR   = 34,                   /*"EXPORT_FIRE_ID_PNG_DIRECTORY"*/
00086     PROP_EXPFPICMF  = 35,                   /*"EXPORT_FIRE_ID_PNG_ICM_FILE"*/
00087     PROP_EXPFPWID   = 36,                   /*"EXPORT_FIRE_ID_PNG_IMG_WIDTH"*/
00088     PROP_EXPFPHGT   = 37,                   /*"EXPORT_FIRE_ID_PNG_IMG_HGT"*/
00089     PROP_EXPFPTTXT  = 38,                   /*"EXPORT_FIRE_ID_PNG_TITLE_TXT"*/
00090     PROP_EXPFPTF    = 39,                   /*"EXPORT_FIRE_ID_PNG_TITLE_FNT"*/
00091     PROP_EXPFPTP    = 40,                   /*"EXPORT_FIRE_ID_PNG_TITLE_POS"*/
00092     PROP_FEXTYP     = 41,                   /*"FIRE_EXTINCTION_TYPE"*/
00093     PROP_FEXHR      = 42,                   /*"FIRE_EXTINCTION_HOURS"*/
00094     PROP_FEXROS     = 43,                   /*"FIRE_EXTINCTION_ROS_MPS"*/
00095     PROP_RGRTYP     = 44,                   /*"FUELS_REGROWTH_TYPE"*/
00096     PROP_FIXFNUM    = 45,                   /*"FUELS_FIXED_MODEL_NUM"*/
00097     PROP_RGRFILE    = 46,                   /*"FUELS_PNV_RGR_FILE"*/
00098     PROP_PNVFMT     = 47,                   /*"FUELS_PNV_RASTER_FORMAT"*/
00099     PROP_PNVMN      = 48,                   /*"FUELS_PNV_RASTER_MAIN_FILE"*/
00100     PROP_PNVHDR     = 49,                   /*"FUELS_PNV_RASTER_HEADER_FILE"*/
00101     PROP_PNVTYP     = 50,                   /*"FUELS_PNV_RASTER_TYPE"*/
00102     PROP_STATFMT    = 51,                   /*"FUELS_STATIC_RASTER_FORMAT"*/
00103     PROP_STATMN     = 52,                   /*"FUELS_STATIC_RASTER_MAIN_FILE"*/
00104     PROP_STATHDR    = 53,                   /*"FUELS_STATIC_RASTER_HEADER_FILE"*/
00105     PROP_STATTYP    = 54,                   /*"FUELS_STATIC_RASTER_TYPE"*/
00106     PROP_SAGETYP    = 55,                   /*"STAND_AGE_TYPE"*/
00107     PROP_SAGEFIX    = 56,                   /*"STAND_AGE_FIXED_AGE"*/   
00108     PROP_SAGEFMT    = 57,                   /*"STAND_AGE_RASTER_FORMAT"*/
00109     PROP_SAGEMN     = 58,                   /*"STAND_AGE_RASTER_MAIN_FILE"*/
00110     PROP_SAGEHDR    = 59,                   /*"STAND_AGE_RASTER_HEADER_FILE"*/
00111     PROP_SAGERTYP   = 60,                   /*"STAND_AGE_RASTER_TYPE"*/ 
00112     PROP_IGTYP      = 61,                   /*"IGNITION_TYPE"*/
00113     PROP_IGFILE     = 62,                   /*"IGNITION_FIXED_IGS_FILE"*/
00114     PROP_IGFREQYR   = 63,                   /*"IGNITION_FREQUENCY_PER_YEAR"*/
00115     PROP_IGRSPFMT   = 64,                   /*"IGNITION_RSP_RASTER_FORMAT"*/
00116     PROP_IGRSPMN    = 65,                   /*"IGNITION_RSP_RASTER_MAIN_FILE"*/
00117     PROP_IGRSPHDR   = 66,                   /*"IGNITION_RSP_RASTER_HEADER_FILE"*/
00118     PROP_IGRSPTYP   = 67,                   /*"IGNITION_RSP_RASTER_TYPE"*/  
00119     PROP_WAZTYP     = 68,                   /*"WIND_AZIMUTH_TYPE"*/
00120     PROP_WAZHFILE   = 69,                   /*"WIND_AZIMUTH_HISTORICAL_FILE"*/
00121     PROP_WAZFFILE   = 70,                   /*"WIND_AZIMUTH_FIXED_FILE"*/
00122     PROP_WAZSPFILE  = 71,                   /*"WIND_AZIMUTH_SPATIAL_FILE"*/ 
00123     PROP_WSPDTYP    = 72,                   /*"WIND_SPEED_TYPE"*/
00124     PROP_WSPDHFILE  = 73,                   /*"WIND_SPEED_HISTORICAL_FILE"*/
00125     PROP_WSPDFFILE  = 74,                   /*"WIND_SPEED_FIXED_FILE"*/
00126     PROP_WSPDSPFILE = 75,                   /*"WIND_SPEED_SPATIAL_FILE"*/       
00127     PROP_DFMTYP     = 76,                   /*"DEAD_FUEL_MOIST_TYPE"*/
00128     PROP_DFMHFILE   = 77,                   /*"DEAD_FUEL_MOIST_HISTORICAL_FILE"*/
00129     PROP_DFMFFILE   = 78,                   /*"DEAD_FUEL_MOIST_FIXED_FILE"*/
00130     PROP_DFMSPFILE  = 79,                   /*"DEAD_FUEL_MOIST_SPATIAL_FILE"*/
00131     PROP_LFMTYP     = 80,                   /*"LIVE_FUEL_MOIST_TYPE"*/
00132     PROP_LFMHFILE   = 81,                   /*"LIVE_FUEL_MOIST_HERB_FILE"*/
00133     PROP_LFMWFILE   = 82,                   /*"LIVE_FUEL_MOIST_WOOD_FILE"*/
00134     PROP_LFMSPFILE  = 83,                   /*"LIVE_FUEL_MOIST_SPATIAL_FILE"*/
00135     PROP_SANAFREQ   = 84,                   /*"SANTA_ANA_FREQUENCY_PER_YEAR"*/
00136     PROP_SANANUMD   = 85,                   /*"SANTA_ANA_NUM_DAYS_DURATION"*/
00137     PROP_SANAWAZF   = 86,                   /*"SANTA_ANA_WIND_AZIMUTH_FILE"*/
00138     PROP_SANAWSPDF  = 87,                   /*"SANTA_ANA_WIND_SPEED_FILE"*/
00139     PROP_SANADFMF   = 88,                   /*"SANTA_ANA_DEAD_FUEL_MOIST_FILE"*/    
00140     PROP_UP_BOUND   = 89                    /* DO NOT EDIT- UPPER ENUMERATION BOUNDS */ 
00141     };
00142 
00147 enum EnumFireVal_   {
00148     VAL_LOW_BOUND   = -1,                   /* DO NOT EDIT- LOWER ENUMERATION BOUNDS */
00149     VAL_ASCII       = 0,                    /*"ASCII"*/
00150     VAL_BINARY      = 1,                    /*"BINARY"*/
00151     VAL_NULL        = 2,                    /*"NULL"*/
00152     VAL_DOUBLE      = 3,                    /*"DOUBLE"*/
00153     VAL_FLOAT       = 4,                    /*"FLOAT"*/
00154     VAL_LONGINT     = 5,                    /*"LONGINT"*/
00155     VAL_INT         = 6,                    /*"INT"*/
00156     VAL_BYTE        = 7,                    /*"BYTE"*/
00157     VAL_FIXED       = 8,                    /*"FIXED"*/
00158     VAL_PNV         = 9,                    /*"PNV"*/
00159     VAL_STATIC      = 10,                   /*"STATIC"*/
00160     VAL_SPATIAL     = 11,                   /*"SPATIAL"*/
00161     VAL_RANDU       = 12,                   /*"RANDOM_UNIFORM"*/
00162     VAL_RANDH       = 13,                   /*"RANDOM_HISTORICAL"*/
00163     VAL_RANDS       = 14,                   /*"RANDOM_SPATIAL"*/
00164     VAL_TABLE       = 15,                   /*"TABLE"*/
00165     VAL_TIMESTEP    = 16,                   /*"TIMESTEP"*/
00166     VAL_DAILY       = 17,                   /*"DAILY"*/
00167     VAL_ANNUAL      = 18,                   /*"ANNUAL"*/
00168     VAL_TINY        = 19,                   /*"TINY"*/
00169     VAL_SMALL       = 20,                   /*"SMALL"*/
00170     VAL_MEDBOLD     = 21,                   /*"MEDBOLD"*/
00171     VAL_LARGE       = 22,                   /*"LARGE"*/
00172     VAL_GIANT       = 23,                   /*"GIANT"*/
00173     VAL_UL          = 24,                   /*"UL"*/
00174     VAL_LL          = 25,                   /*"LL"*/
00175     VAL_LR          = 26,                   /*"LR"*/
00176     VAL_UR          = 27,                   /*"UR"*/
00177     VAL_CONS        = 28,                   /*"CONSUME"*/
00178     VAL_REIG        = 29,                   /*"REIGNITE"*/
00179     VAL_ROTH        = 30,                   /*"ROTH"*/
00180     VAL_PHYS        = 31,                   /*"PHYS"*/  
00181     VAL_UP_BOUND    = 32                    /* DO NOT EDIT- UPPER ENUMERATION BOUNDS */     
00182     };
00183      
00184 /*
00185  *********************************************************
00186  * STRUCTS, TYPEDEFS
00187  *********************************************************
00188  */
00189 
00193 typedef enum EnumFireProp_ EnumFireProp;
00194 
00198 typedef enum EnumFireVal_ EnumFireVal;
00199 
00200 /*
00201  *********************************************************
00202  * MACROS
00203  *********************************************************
00204  */
00205 
00206 /*
00207  *********************************************************
00208  * PUBLIC FUNCTIONS
00209  *********************************************************
00210  */
00211 
00219 const char * GetFireProp(EnumFireProp p);
00220 
00228 const char * GetFireVal(EnumFireVal v);
00229  
00230 #endif FireProp_H       /* end of FireProp.h */

Generated at Fri Jun 22 00:46:51 2001 for HFire by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000