ALMaSS  1.2 (after EcoStack, March 2024)
The Animal, Landscape and Man Simulation System
BroadBeans.h
Go to the documentation of this file.
1 //
2 // BroadBeans.h
3 //
4 /*
5 *******************************************************************************************************
6 Copyright (c) 2015, Christopher John Topping, Aarhus University
7 All rights reserved.
8 
9 Redistribution and use in source and binary forms, with or without modification, are permitted provided
10 that the following conditions are met:
11 
12 Redistributions of source code must retain the above copyright notice, this list of conditions and the
13 following disclaimer.
14 Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
15 the following disclaimer in the documentation and/or other materials provided with the distribution.
16 
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
18 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
19 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
20 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
22 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 ********************************************************************************************************
26 */
27 
28 #ifndef BroadBeans_H
29 #define BroadBeans_H
30 
31 #define BBEANS_BASE 1200
32 
33 
34 typedef enum {
35  bb_start = 1, // Compulsory, start event must always be 1 (one).
48 
49 
50 
51 class BroadBeans : public Crop {
52 public:
53  bool Do( Farm *a_farm, LE *a_field, FarmEvent *a_ev );
54  BroadBeans(TTypesOfVegetation a_tov, TTypesOfCrops a_toc, Landscape* a_L) : Crop(a_tov, a_toc, a_L)
55  {
56  m_first_date = g_date->DayInYear( 1, 3 );
58  }
60  const int elements = 2 + (bb_foobar - BBEANS_BASE);
62 
63  FarmManagementCategory catlist[elements] =
64  {
65  fmc_Others, // zero element unused but must be here
66  fmc_Others, // bb_start = 1, // Compulsory, start event must always be 1 (one).
67  fmc_Harvest, // bb_harvest = BBEANS_BASE,
68  fmc_Cultivation, // bb_spring_plough,
69  fmc_Cultivation, // bb_spring_harrow,
70  fmc_Others, // bb_spring_sow,
71  fmc_Cultivation, // bb_spring_roll,
72  fmc_Cultivation, // bb_strigling,
73  fmc_Cultivation, // bb_rowcultivation,
74  fmc_Watering, // bb_water_one,
75  fmc_Watering, // bb_water_two,
76  fmc_Others // bb_wait,
77 
78 
79  // no foobar entry
80 
81  };
82  // Iterate over the catlist elements and copy them to vector
83  copy(begin(catlist), end(catlist), back_inserter(m_ManagementCategories));
84 
85  }
86 
87 };
88 
89 #endif // BroadBeans_H
LE::GetMDates
int GetMDates(int a, int b)
Definition: Elements.h:405
Farm::SpringRoll
virtual bool SpringRoll(LE *a_field, double a_user, int a_days)
Carry out a roll event in the spring on a_field.
Definition: FarmFuncs.cpp:487
Landscape::SupplyLEPointer
LE * SupplyLEPointer(int a_polyref)
Returns a pointer to the object referred to by the polygon number.
Definition: Landscape.h:1722
WARN_FILE
Definition: MapErrorMsg.h:37
LE::SetMDates
void SetMDates(int a, int b, int c)
Definition: Elements.h:406
Farm::SpringPlough
virtual bool SpringPlough(LE *a_field, double a_user, int a_days)
Carry out a ploughing event in the spring on a_field.
Definition: FarmFuncs.cpp:421
Farm::Strigling
virtual bool Strigling(LE *a_field, double a_user, int a_days)
Carry out a mechanical weeding on a_field.
Definition: FarmFuncs.cpp:1206
bb_water_two
Definition: BroadBeans.h:44
Farm::Harvest
virtual bool Harvest(LE *a_field, double a_user, int a_days)
Carry out a harvest on a_field.
Definition: FarmFuncs.cpp:1364
bb_foobar
Definition: BroadBeans.h:46
FarmEvent::m_lock
bool m_lock
Definition: Farm.h:384
bb_water_one
Definition: BroadBeans.h:43
bb_spring_harrow
Definition: BroadBeans.h:38
FarmEvent
A struct to hold the information required to trigger a farm event.
Definition: Farm.h:372
LE::ClearManagementActionSum
void ClearManagementActionSum()
clears the management action counters
Definition: Elements.h:247
bb_wait
Definition: BroadBeans.h:45
Farm::DoIt
bool DoIt(double a_probability)
Return chance out of 0 to 100.
Definition: Farm.cpp:856
Calendar::GetYearNumber
int GetYearNumber(void)
Definition: Calendar.h:72
FarmEvent::m_first_year
bool m_first_year
Definition: Farm.h:386
bb_spring_plough
Definition: BroadBeans.h:37
g_date
class Calendar * g_date
Definition: Calendar.cpp:37
BroadBeans::BroadBeans
BroadBeans(TTypesOfVegetation a_tov, TTypesOfCrops a_toc, Landscape *a_L)
Definition: BroadBeans.h:54
Farm::GetNextCropStartDate
int GetNextCropStartDate(LE *a_field, TTypesOfVegetation &a_curr_veg)
Returns the start date of the next crop in the rotation.
Definition: Farm.cpp:920
Farm::AddNewEvent
void AddNewEvent(TTypesOfVegetation a_event, long a_date, LE *a_field, int a_todo, long a_num, bool a_lock, int a_start, bool a_first_year, TTypesOfVegetation a_crop, FarmManagementCategory a_fmc, bool a_forcespring, bool a_forcespringOK)
Adds an event to the event queue for a farm.
Definition: Farm.cpp:845
Farm::SpringSow
virtual bool SpringSow(LE *a_field, double a_user, int a_days, double a_seed_coating_amount=-1, PlantProtectionProducts a_ppp=ppp_foobar)
Carry out a sowing event in the spring on a_field.
Definition: FarmFuncs.cpp:501
CfgFloat::value
double value() const
Definition: Configurator.h:142
Farm::GetType
TTypesOfFarm GetType(void)
Definition: Farm.h:956
Crop::m_base_elements_no
int m_base_elements_no
Definition: Farm.h:505
bb_start
Definition: BroadBeans.h:35
Crop::m_first_date
int m_first_date
Definition: Farm.h:501
FarmEvent::m_startday
int m_startday
Definition: Farm.h:385
Crop
The base class for all crops.
Definition: Farm.h:495
Crop::SimpleEvent
void SimpleEvent(long a_date, int a_todo, bool a_lock)
Adds an event to this crop management.
Definition: Farm.cpp:747
BroadBeans::Do
bool Do(Farm *a_farm, LE *a_field, FarmEvent *a_ev)
Definition: BroadBeans.cpp:34
tov_BroadBeans
Definition: LandscapeFarmingEnums.h:228
Landscape
The landscape class containing all environmental and topographical data.
Definition: Landscape.h:142
Calendar::Date
long Date(void)
Definition: Calendar.h:57
fmc_Cultivation
Definition: LandscapeFarmingEnums.h:1008
bb_spring_roll
Definition: BroadBeans.h:40
fmc_Others
Definition: LandscapeFarmingEnums.h:1003
LE::SetVegPatchy
void SetVegPatchy(bool p)
Definition: Elements.h:229
bb_spring_sow
Definition: BroadBeans.h:39
bb_harvest
Definition: BroadBeans.h:36
fmc_Watering
Definition: LandscapeFarmingEnums.h:1011
Calendar::OldDays
long OldDays(void)
Definition: Calendar.h:60
MapErrorMsg::Warn
void Warn(MapErrorState a_level, std::string a_msg1, std::string a_msg2)
Definition: MapErrorMsg.cpp:69
BroadBeans::SetUpFarmCategoryInformation
void SetUpFarmCategoryInformation()
Definition: BroadBeans.h:59
FarmEvent::m_field
LE * m_field
Definition: Farm.h:391
FarmEvent::m_next_tov
TTypesOfVegetation m_next_tov
Definition: Farm.h:390
Crop::m_farm
Farm * m_farm
Definition: Farm.h:498
BBEANS_BASE
#define BBEANS_BASE
Definition: BroadBeans.h:31
Crop::m_field
LE * m_field
Definition: Farm.h:499
Crop::m_ManagementCategories
vector< FarmManagementCategory > m_ManagementCategories
Holds the translation between the farm operation enum for each crop and the farm management category ...
Definition: Farm.h:530
FarmEvent::m_todo
int m_todo
Definition: Farm.h:388
tov_Undefined
Definition: LandscapeFarmingEnums.h:610
LE::SetVegType
virtual void SetVegType(TTypesOfVegetation)
Definition: Elements.h:175
TTypesOfCrops
TTypesOfCrops
Definition: LandscapeFarmingEnums.h:781
Farm::RowCultivation
virtual bool RowCultivation(LE *a_field, double a_user, int a_days)
Carry out a harrowing between crop rows on a_field.
Definition: FarmFuncs.cpp:1183
tof_OptimisingFarm
Definition: LandscapeFarmingEnums.h:696
LE
Definition: Elements.h:86
Farm::Water
virtual bool Water(LE *a_field, double a_user, int a_days)
Carry out a watering on a_field.
Definition: FarmFuncs.cpp:1330
Crop::m_last_date
int m_last_date
Definition: Farm.h:503
g_msg
MapErrorMsg * g_msg
Definition: MapErrorMsg.cpp:41
TTypesOfVegetation
TTypesOfVegetation
Values that represent the types of vegetation that are represented in ALMaSS.
Definition: LandscapeFarmingEnums.h:192
Farm
The base class for all farm types.
Definition: Farm.h:755
cfg_strigling_prop
CfgFloat cfg_strigling_prop
CfgFloat
Double configurator entry class.
Definition: Configurator.h:126
fmc_Harvest
Definition: LandscapeFarmingEnums.h:1012
bb_rowcultivation
Definition: BroadBeans.h:42
BroadBeansToDo
BroadBeansToDo
Definition: BroadBeans.h:34
bb_strigling
Definition: BroadBeans.h:41
LE::GetUnsprayedMarginPolyRef
int GetUnsprayedMarginPolyRef(void)
Definition: Elements.h:383
LE::GetSoilTypeR
int GetSoilTypeR()
Definition: Elements.h:326
tov_GenericCatchCrop
Definition: LandscapeFarmingEnums.h:339
Calendar::DayInYear
int DayInYear(void)
Definition: Calendar.h:58
PROG_START
#define PROG_START
Definition: Farm.h:69
Crop::m_ev
FarmEvent * m_ev
Definition: Farm.h:500
Crop::m_OurLandscape
Landscape * m_OurLandscape
Definition: Farm.h:506
WARN_BUG
Definition: MapErrorMsg.h:34
BroadBeans
Definition: BroadBeans.h:51
FarmManagementCategory
FarmManagementCategory
Definition: LandscapeFarmingEnums.h:1001
Farm::SpringHarrow
virtual bool SpringHarrow(LE *a_field, double a_user, int a_days)
Carry out a harrow event in the spring on a_field.
Definition: FarmFuncs.cpp:459