BasicEnums.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//
//      Thomas Berger (main author), Pepijn Schreinemachers, and Thorsten Arnold
//
//
//      Hohenheim University (490d)
//      Professorship for Land Use Economics in the Tropics and Subtropics
//
//      May not be distributed without permission by main author
//
//      File:                           BasicEnums.h (formerly enum_defs.h)
//
//      Contents:               Contains enumeration lists
//
//
//
//------------------------------------------------------------------------------


#ifndef _BasicEnums_h
#define _BasicEnums_h

enum WaterAssignmentType
{       onlyActual,
        onlyRandom,
        bothRights
};

enum    typeIrrigationMethod
{       irrigMethodFlood,
        irrigMethodFurrow,
        irrigMethodTerrassing,
        irrigMethodDrip,
        irrigMethodImprovedFurrow,
        irrigMethodAdvancedFurrow,  //californiano
        irrigMethodSprinkler,
        /* TODO 5 -oBerger -cImplement : include new irrigaiton methods in water balance */
        // Comment Arnold: Not required, it does it automatically. But this "typeIrrigationMethod" is a workaround and should not be
        // extended! 
        // Note: Each new irrigation method also requires a string BasicData::getStringIrrigationMethods(typeIrrigationMethod)
        irrigMethodTape,
        irrigMethodCenterPivot,
        irrigMethodMicroSprinkler,
        irrigMethodEND
};

enum TypeRoleInCoupling 
{       typeSequencer, 
        typeDatamanager,        
        typeMPMAS, 
        typeWasimWrapper, 
        typeCropModel           
};


enum TypeDataExchangeType       
{       typeMatrixDouble,       
        typeRaster2D            
};



enum TypeDataExchangeChannel 
{ 
//      0                                                       1                                               2                                                       3                               4                               5                                                       
        typeControllerToPerif1,  typePerif1ToController, typeControllerToPerif2,        typePerif2ToController, typeControllerToPerif3,  typePerif3ToController, 
//      6                                                       7                                               8                                                       9                               10                      11                                                      
        typeControllerToPerif4,  typePerif4ToController, typeControllerToPerif5,        typePerif5ToController, typeControllerToPerif6,  typePerif6ToController 
};


enum    TypeHydroModel
{       typeHydroNull,
        typeHydroEdic,
        typeHydroWasim
};

enum    TypeCropModel
{       typeCropNull,
        typeCropTspc,
        typeCropWat
};

enum TypeEdicFlow
{       enumMethodPlantuptake,
        enumMethodSurfaceOvernight,             // These are set afterwards, by hand
        enumMethodSurface,
        enumMethodLateral,
        enumMethodDeep,
        enumMethod_MAX_read,            // These are automatically read from file
        enumMethodCanalDeep,
        enumMethodCanalLateral,
   enumMethodCanalSurface,
        enumMethodEND
};
                 
enum POSITIONMATRIXtranslation
{       posM_LPcol,     posM_crA,       posM_CropID,    posM_tech,       posM_max,
        posM_LUwasim,   posM_freq, posM_binQuant,       posM_bin,       posM_numG
};


// if
//              FileTypeEnum fileTypeGisInput:  file in input/gis/
//              FileTypeEnum fileTypeIsDAT:     file in input/dat/
//              ...     see     function getFullMpmasFilename
enum    EnumFileType
{       fileTypeGisInput,       fileTypeGisOutputYearly, fileTypeGisOutputMonthly, fileTypeIsDAT, fileTypeIsDatByCatchment, fileTypeIsDatYearly,
        fileTypeIsDatMonthly, fileTypeIsTEST, fileTypeIsOUT, fileTypeIsOutByCatchment,
        fileTypeIsOutByCatchmentAndMonth
};


enum Content
// 0                            1                                       2                                        3                                       4
{       // GisFiles:
        contFarmID,             contPropID,      contSoilID,             contCluID,                      contNetwID,
        contPopID,              contAgentID,            contDistFromHome,       contUser, contSectorID,         contENDBASIC,   
        
        // Types used   by TSPC-Model
        contSoilN,       contSoilP,                      contSoilK,                      contSoilA,
        contSoilC,              contSoilSl,      contSoilSe,
   contSlopeLen,        contSlopeErosion,       contSoilCond,    contENDTSPC,   
        
        // irrigation data handled in MPMAS 
        contCropAct,    contPrecip, contIrrigQuantEdic, contENDIRRIG,

        // Further data handled in "coupling" matrices
   //  ... the order is important: They are allocated into an 
   //  ... array of dimension ((contENDCOUPL - contENDIRRIG + 1) = contENDCOUPL - contENDIRRIG), 
   //  ... and stored in matrices within the clas cell. Used also during coupling!
   contSoilMoist, contSoilMoist05, contSoilMoist1, contETpot, contETreal, 
   contSurfaceRunoff, contPercol, contBaseFlow, contGroundwaterRecharge,  
        contIrrigGrid,  contLUGrid,      contLUwasim,   contETdiff,     contFlowMat,
        contWATERWAYS, contDEM, contIrrigQuant, contInterceptEvap, contThrougfall,  
        contENDCOUPL, 
   
   // Other formats, or special types, that are not gridded data
   contLUTable, contIrrigTable, 

        // DAT Files
        fileTypeBasicData,      fileTypeMarket, fileTypePCrops, fileTypeSoils, fileTypeMILP,
        fileTypeLivestock,      fileTypeSegment, fileTypePopulation, fileTypeCluster,
        fileTypeEdicCalibrationFactor,  fileTypeEdicSurfaceRunoff, fileTypeEdicLateralFlows, fileTypeEdicRiverFlows,
        fileTypeEdicIrrigationMethods,  fileTypeRegion, fileTypeCropWat,
        fileTypeEffectivePrecip, fileTypeActualPrecip, 
        fileTypeSectorRandomWaterRights,        fileTypeSectorActualWaterRights, fileTypeSectorInfrastructureProjects,
        fileTypeLanduseByCatchment, fileTypeTimeHandler, fileTypeIrrigationFactors, fileTypeSpatialExportInfo, 
        fileTypeENDFILETYPE,
        
        // General
        contIsInit,      contNotInit,    contNotFound,   contData,      contNOTYPE, contEMPTY,          contNoDataVal,  contmapData,

        // ControlFile
        contCntrlData, contSectorCntrl, contOutputData, contMonthlyData, contMAXLEN
};

enum ExportType
// 0                            1                                2                  3                        4
// 5                            6                               7                    8                       9
{
         expFlowMat, expIrrigTable, expLUTable, expIrrigGrid, expLUGrid,
         expWATERWAYS,   expDEM, expSoilMoist,   expSoilMoist05, expSoilMoist1,  expETpot, expETreal,
         expETdiff,  expPrecip ,  expIrrigQuant, expSurfaceRunoff,    expBaseFlow, expGroundwaterRecharge, 
         expInterceptEvap, expThroughfall, expPercol,  expNOTYPE
};

// Filenames initialized in     function "init_strings.cpp:     initFILENAMES()"
enum KEYTYPE
{       keyDEFAULTS, keyMAS2WASIM, keyCROPACT, keyWASIMFILENAMES,       keySECTORtight,
        keySECTORFULL, keyENUM_SECIDS, keyENUM_CatchIDS, keyDATAEXCH,   
        keyACTIVITY, keyLU_fixed,       keyPROP, keyELEV,       keyLOG, keyLOG2, keyTABLE_onetime,
        keyTABLE_timeseries, keyLUFILTER,       keyFILTER_FINE, keyWasimZONEascii,
        keyINFLOWvect,           /*     [monthly]/inflow         */
        keyMedianVect,           /*     sectorFlows             */
        keyMonthlyDir,           /*     monthly         */
        keyAbstraTrunk,          /*     abstra */
        keyIrrigDir,                     /*             "irrigTables"   */
        keyIrrigTrunk,           /*      "IrrigationTable" */
        keySectorRaster_WasimResolution, /*   "" */
//      keyWasimLU,                                      
//      keyWasimIRR,                     /*     irrigation grid, WASIM resolution, raster       ascii   file */
 
        keyZoneBinary,           /*     in WASIM FILENAMES */
        keyWasimControlTemp,
        keyWasimControlFin,     /* in   WASIM   FILENAMES       */
        
        keyIRR_InflowMat,                        /*     in Filename     for     temporary       file:   water   per     sector during   irrigation run */
        keyTimeHandler, 
        keyFilenamesInitialize, 
        keyIrrigationTableBackground,
        keyWasimIrrigationRasterBackground,     /* Default irrigation   grid,   WASIM   resolution,     raster ascii file       */
        keyWasimIrrigationRasterBinary, 
        keyWasimRasterLanduseBackground,                 /*     Default irrigation grid, WASIM resolution, raster       ascii   file */
        keyIrrigationTableForStandalone, 
        keyIrrigationGridForStandalone, 
        keyLanduseGridForStandalone, 
        keyCropKey,     
        keyActivityKey, 
   keyIrrigationFactors, 
   keyFilesMax           
};

enum enumIrrigationPosition     
{       posIrrID,       posIrrTech,     posIrrClust, posIrrLUC
};


#ifndef LP_OLD


enum SolverType
{       symphony,
        cbc,
        osl
};

enum CapacityType
{       labor,
        liquidity,
        firstWater,
        firstSoil,
        averageCapital,
        averageLabor,
        averageMachinery,
        //averageDraft, ##
        binaryDisinvestmentCap,
        firstFoodNutrientDemand,
        soilInvestments
};

enum ActivityType
{       saving,
        extraConsumption,
        femaleLaborYes,
        femaleLaborNo,
        maleLaborYes,
        maleLaborNo,
        binaryDisinvestmentAct, 
        manureAccounting,
        fixedVariablesConsumption
};      
//-----------------------------------------
#endif /*LP_OLD*/

enum EarningType
{       other,
        earningsInCash,
        earningsInKind,
        purchasedFood,
        consumedProducedFood
};


enum enumYieldInfo 
{       typeYieldInfo_waterActivityID, 
        typeYieldInfo_areaPlanted, 
        typeYieldInfo_lpColumn,                 
        typeYieldInfo_priceColumn, 
        typeYieldInfo_yieldRow,
        typeYieldInfo_irrigationPriority,  
        typeYieldInfo_irrigationType, 
        typeYieldInfo_plantShare,
        typeYieldInfo_preHarvestCostsPerHa,
        typeYieldInfo_potentialYieldPerHa, 
        typeYieldInfo_expectedYieldPerHa, 
        typeYieldInfo_actualYieldPerHa, 
        typeYieldInfo_potentialTotalProduction, 
        typeYieldInfo_expectedTotalProduction, 
        typeYieldInfo_actualTotalProduction, 
        typeYieldInfo_reductionCoefficientKr, 
        typeYieldInfo_yieldReductionFactor, 
        typeYieldInfo_totalProductionLoss,//here: compared to expected    
        typeYieldInfo_MAX
};

enum enumActivityType
{       type_sellingBuying,             //(0) Selling/buying activity
        type_irrigatedAnnual,   //(1) Growing an irrigated annual crop
        type_irrigatedPerennial,//(2) Growing an irrigated permanent crop 
        type_divisibleIrrigated,//(3) Divisible investment goods with irrigation 
        type_indivisible,                       //(4) Indivisible investment goods without irrigation 
        type_rainfedAnnual,             //(5) Rainfed annual crop
        type_rainfedPerennial,  //(6) Rainfed perennial crop
        type_activityTypeMAX            //(-1) All other activities
};

#define AGENTF_ENTRIES_BEFORE_LABOR 11 //changed from 8 to 11, quick fix  ## 080812
#define AGENTF_ENTRIES_BEFORE_PER_HA 5 //quick fix ## 080812
#define STATUS_ADDITIONAL 1

enum columnsInPermamentCropsRegistry                    //<dkult_reg>
{       typePermCrops_investmentObjectID,                       //formerly 17 //order may not be changed
        typePermCrops_status,                     //formerly 0  //order may not be changed
        
        typePermCrops_activityLP,       //quick fix ## 080812
        typePermCrops_yieldRowLP,       //quick fix ## 080812
        typePermCrops_sizeHa,           //quick fix ## 080812

        typePermCrops_currentCropYield,                         //formerly 15
        typePermCrops_currentVariableCosts,                     //formerly 16
        typePermCrops_currentPreHarvestCosts,           //formerly 3

        typePermCrops_futureCropYield,                          //formerly 1
        typePermCrops_futureVariableCosts,                      //formerly 2
        typePermCrops_futurePreHarvestCosts,            //formerly 9

        //typePermCrops_currentLaborDemand,                     //formerly 4    //##
        //typePermCrops_currentLaborPeak1Demand,                //formerly 7    //##
        //typePermCrops_currentLaborPeak2Demand,                //formerly 8    //##
        //                                                                                                                                                      

        //typePermCrops_averageLaborDemand,                     //formerly 10   //##
        //typePermCrops_averageLaborPeak1Demand,                //formerly 13   //##
        //typePermCrops_averageLaborPeak2Demand,                //formerly 14   //##
        //                                                                                                                                                      
        //typePermCrops_currentHeavyMachineryDemand,//formerly 5        //##
        //typePermCrops_currentLightMachineryDemand,//formerly 6        //##

        //typePermCrops_averageHeavyMachineryDemand,//formerly 11       //##
        //typePermCrops_averageLightMachineryDemand,//formerly 12       //##

        typePermCrops_MAX
};

enum enumTypeCanalModel                                          //
{       typeModeInherited,                              //0
        typeModeRedistributed,                  //1
        typeModeRedistributedLambda,                            //2
        typeModeMixedInhRedistr,
   typeModeMixedInhRedistrLambda,
   max_typeModeMixed  
};





#define CULTIVO_ENTRIES_BEFORE_LABOR 3
enum rowsInPerennialCropsHandler                                        //<anbaudaten>
{       permCropsHandler_relativeYield,                         //0
        permCropsHandler_preHarvestCosts,                       //1
        permCropsHandler_harvestCosts,                          //2
        permCropsHandler_MAX
};


//Ghana
#define GHANA_NONIRRIGABLE_PLOT 0

//Chile
#define CHILE_SOIL_TYPE_FRUITS 0
#define PEAK_LABOR_FRUIT 0.75
#define PEAK_LABOR_BERRY 1.5
#define MIN_HECTARE_T2 5.0

enum objectTypesInLottery
{       objTypeLeverage = -5,   // -5
        objTypeLiquidity,                       //      -4      
        objTypeExpectations,            // -3 
        objTypeInnovativeness,  // -2 
        objTypeFemaleHead,              // -1 
        objTypeDefault,                 //  0   object with land demand 
        objTypeNoLandDemand,            //       1 object without land demand
        objTypeSymbolicObjects, //  2   
//----------------------------------------------------------    
        objTypeFruitProduction, //  3 country-specific Chile
        objTypeBerryProduction, //  4
   objTypeHiringPeakLabor,      //       5 
        objTypeMachineryT0,             //  6  
   objTypeMachineryT1,          //  7 
        objTypeMachineryT2,             //  8 
        objTypeMachineryT3,             //  9 
        objTypeHiringT2,                        // 10  
        objTypeHiringT3,                        // 11
        objTypeMAX                                                      
};


#endif

---