Loading [MathJax]/extensions/ams.js
ALMaSS  1.2 (after EcoStack, March 2024)
The Animal, Landscape and Man Simulation System
All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FI_BufferZone Class Reference

FI_BufferZone class
. More...

#include <FI_BufferZone.h>

Inheritance diagram for FI_BufferZone:
Crop

Public Member Functions

virtual bool Do (Farm *a_farm, LE *a_field, FarmEvent *a_ev)
 The one and only method for a crop management plan. All farm actions go through here. More...
 
 FI_BufferZone (TTypesOfVegetation a_tov, TTypesOfCrops a_toc, Landscape *a_L)
 
void SetUpFarmCategoryInformation ()
 
- Public Member Functions inherited from Crop
virtual ~Crop ()
 
 Crop (TTypesOfVegetation a_tov, TTypesOfCrops a_toc, Landscape *a_L)
 
int GetFirstDate (void)
 
void ChooseNextCrop (int a_no_dates)
 Chooses the next crop to grow in a field. More...
 
int GetCropClassification ()
 
void SetCropClassification (int a_classification)
 
void GetCropType (TTypesOfCrops a_toc)
 
TTypesOfCrops GetCropType ()
 
FarmManagementCategory LookUpManagementCategory (int a_todo)
 
bool GetForceSpringOK ()
 

Additional Inherited Members

- Public Attributes inherited from Crop
TTypesOfVegetation m_tov
 
- Protected Member Functions inherited from Crop
void SimpleEvent (long a_date, int a_todo, bool a_lock)
 Adds an event to this crop management. More...
 
void SimpleEvent_ (long a_date, int a_todo, bool a_lock, Farm *a_farm, LE *a_field)
 Adds an event to this crop management without relying on member variables. More...
 
bool StartUpCrop (int a_spring, std::vector< std::vector< int >> a_flexdates, int a_todo)
 
Holds the translation between the farm operation enum for each cropand the farm management category associated with it More...
 
bool AphidDamage (LE *a_field)
 Compares aphid numbers per m2 with a threshold to return true if threshold is exceeded. More...
 
- Protected Attributes inherited from Crop
Farmm_farm
 
LEm_field
 
FarmEventm_ev
 
int m_first_date
 
int m_count
 
int m_last_date
 
int m_ddegstoharvest
 
int m_base_elements_no
 
Landscapem_OurLandscape
 
bool m_forcespringpossible = false
 Used to signal that the crop can be forced to start in spring. More...
 
TTypesOfCrops m_toc
 The Crop type in terms of the TTypesOfCrops list (smaller list than tov, no country designation) More...
 
int m_CropClassification
 Contains information on whether this is a winter crop, spring crop, or catch crop that straddles the year boundary (0,1,2) More...
 
vector< FarmManagementCategorym_ManagementCategories
 Holds the translation between the farm operation enum for each crop and the farm management category associated with it. More...
 
- Static Protected Attributes inherited from Crop
static int m_date_modifier = 0
 Holds a value that shifts test pesticide use by this many days in crops modified to use it. More...
 

Detailed Description

FI_BufferZone class
.

See FI_BufferZone.h::FI_BufferZoneToDo for a complete list of all possible events triggered codes by the BufferZone management plan. When triggered these events are handled by Farm and are available as information for other objects such as animal and bird models.

Constructor & Destructor Documentation

◆ FI_BufferZone()

FI_BufferZone::FI_BufferZone ( TTypesOfVegetation  a_tov,
TTypesOfCrops  a_toc,
Landscape a_L 
)
inline
90  : Crop(a_tov, a_toc, a_L)
91  {
92  // When we start it off, the first possible date for a farm operation
93  // This information is used by other crops when they decide how much post processing of
94  // the management is allowed after harvest before the next crop starts.
95  m_first_date = g_date->DayInYear(15, 6);
97  }

References Calendar::DayInYear(), g_date, Crop::m_first_date, and SetUpFarmCategoryInformation().

Member Function Documentation

◆ Do()

bool FI_BufferZone::Do ( Farm a_farm,
LE a_field,
FarmEvent a_ev 
)
virtual

The one and only method for a crop management plan. All farm actions go through here.

Called every time something is done to the crop by the farmer in the first instance it is always called with a_ev->todo set to start, but susequently will be called whenever the farmer wants to carry out a new operation.
This method details all the management and relationships between operations necessary to grow and ALMaSS crop - in this case conventional spring barley Fodder.

Reimplemented from Crop.

99 {
100  m_field = a_field; // this is needed because of possible calls to other methods and currently we do not pass parameters.
101  m_farm = a_farm; // this is needed because of possible calls to other methods and currently we do not pass parameters.
102  m_ev = a_ev;
103  bool done = false; // The boolean value done indicates when we are totally finished with this plan (i.e. it is set to true).
104  int d1 = 0;
105  // Depending what event has occured jump to the correct bit of code e.g. for ww_start jump to line 67 below
106  switch (a_ev->m_todo)
107  {
108  case fi_bz_start:
109  {
110  FI_BZ_YEARS_AFTER_SOW = 0; //Here FI_BZ_YEARS_AFTER_SOW flag should get randomly for each field a value
111  //THIS PART SHOULD BE SOMEWHERE ELSE OUTSIDE THE PLAN, SO THE STARTING CONDITIONS FOR FIELDS WITH PERMANENT GRASS (YEAR AFTER SOWING)
112  // IS SET ONLY ONCE AT THE SIMULATION START!!!
113 
114  a_field->ClearManagementActionSum();
115 
116 // Check the next crop for early start, unless it is a spring crop
117  // in which case we ASSUME that no checking is necessary!!!!
118  // So DO NOT implement a crop that runs over the year boundary (i.e. from spring to spring!), at least not without fixing this.
119 
120  //new if: do the check only for non-optimising farms and if year>0. (030713 - m_rotation used only in the hidden year, so I modified the condition from >7 to >0)
121  //optimising farms not used for now so most of related code is removed (but not in 'start' case)
122  if (!(a_farm->GetType() == tof_OptimisingFarm && g_date->GetYearNumber() > 0)) {
123  //Checking the future...
124  if (a_ev->m_startday > g_date->DayInYear(1, 7)) {
125  if (g_date->DayInYear(30, 12) >= a_ev->m_startday)
126  {
127  g_msg->Warn(WARN_BUG, "FIBufferZone::Do(): ", "Harvest too late for the next crop to start!!!");
128  int almassnum = a_field->GetLandscape()->BackTranslateVegTypes(a_ev->m_next_tov);
129  g_msg->Warn("Next Crop ", (double)almassnum); // this causes exit
130  exit(1);
131  }
132  }
133  // Now no operations can be timed after the start of the next crop.
134 
135  if (!a_ev->m_first_year) {
136  // Are we before July 1st?
137  d1 = g_date->OldDays() + g_date->DayInYear(1, 7);
138  if (g_date->Date() < d1) {
139  // Yes, too early. We assumme this is because the last crop was late
140  printf("Poly: %d\n", a_field->GetPoly());
141  g_msg->Warn(WARN_BUG, "FIBufferZone::Do(): ", "Crop start attempt between 1st Jan & 1st July");
142  int prev = a_field->GetLandscape()->BackTranslateVegTypes(a_field->GetOwner()->GetPreviousTov(a_field->GetRotIndex()));
143  g_msg->Warn(WARN_BUG, "Previous Crop ", prev);
144  int almassnum = a_field->GetLandscape()->BackTranslateVegTypes(a_ev->m_next_tov);
145  g_msg->Warn("Next Crop ", (double)almassnum); // this causes exit
146  }
147  else {
148  d1 = g_date->OldDays() + 365 + m_first_date; // Add 365 for spring crop
149  if (g_date->Date() > d1) {
150  // Yes too late - should not happen - raise an error
151  g_msg->Warn(WARN_BUG, "FIBufferZone::Do(): ", "Crop start attempt after last possible start date");
152  g_msg->Warn(WARN_BUG, "Previous Crop ", "");
153  a_field->GetOwner()->GetPreviousTov(a_field->GetRotIndex());
154  int almassnum = a_field->GetLandscape()->BackTranslateVegTypes(a_ev->m_next_tov);
155  g_msg->Warn("Next Crop ", (double)almassnum); // this causes exit
156  }
157  }
158  }
159  else {
160  //only for the first year
161  SimpleEvent(g_date->OldDays() + g_date->DayInYear(1, 5), fi_bz_sow, false);
162  break;
163  }
164  }//if
165 
166  // End single block date checking code. Please see next line comment as well.
167  // OK, let's go.
168  // Here we queue up the first event
169  //Each field has assign randomly a FI_NG_YEARS_AFTER_SOW flag value from 1 to 5
170 
171  if ((FI_BZ_YEARS_AFTER_SOW + g_date->GetYearNumber()) % 1 == 1)
172  {
173  d1 = g_date->OldDays() + g_date->DayInYear(1, 1);
174  if (g_date->Date() >= d1) d1 += 365;
175  SimpleEvent(d1, fi_bz_sow, false);
176  }
177  else if ((FI_BZ_YEARS_AFTER_SOW + g_date->GetYearNumber()) % 1 == 0)
178  {
179  d1 = g_date->OldDays() + g_date->DayInYear(1, 8);
180  if (g_date->Date() >= d1) d1 += 365;
181  SimpleEvent(d1, fi_bz_grazing1, false);
182  }
183  break;
184  }
185  break; // this thread is only done the first year
186  case fi_bz_sow: // 10% will sow catch crop together with grass (spring cereal)
187  if (a_ev->m_lock || a_farm->DoIt(100)) {
188  if (!a_farm->SpringSow(a_field, 0.0, g_date->DayInYear(15, 6) - g_date->DayInYear())) {
189  SimpleEvent(g_date->Date() + 1, fi_bz_sow, true);
190  break;
191  }
192  }
193  //here comes next events:
194  SimpleEvent(g_date->Date(), fi_bz_slurry, false);
195  break;
196  case fi_bz_slurry: //suggest 50% does this and the rest choose NPK fertilizer (crop scheme only say: 100% do Slurry/NPK)
197  if (m_farm->IsStockFarmer()) { //Stock Farmer
198  if (!a_farm->FA_Slurry(a_field, 0.0, g_date->DayInYear(15, 6) - g_date->DayInYear())) {
199  SimpleEvent(g_date->Date() + 1, fi_bz_slurry, true);
200  break;
201  }
203  break;
204  }
205  else SimpleEvent(g_date->Date(), fi_bz_npk, false);
206  break;
207  case fi_bz_npk: //suggest 50% does this and the rest choose NPK fertilizer (crop scheme only say: 100% do Slurry/NPK)
208  if (!a_farm->FA_NPK(a_field, 0.0, g_date->DayInYear(15, 6) - g_date->DayInYear())) {
209  // If we don't succeed on the first try, then try and try again (until 10/10 when we will succeed)
210  SimpleEvent(g_date->Date() + 1, fi_bz_npk, true);
211  break;
212  }
214  break;
215  case fi_bz_grazing1:
216  if (a_ev->m_lock || a_farm->DoIt_prob(.50)) {
217  if (!a_farm->CattleOut(a_field, 0.0,
218  g_date->DayInYear(30, 9) - g_date->DayInYear())) {
219  SimpleEvent(g_date->Date() + 1, fi_bz_grazing1, true);
220  break;
221  }
223  break;
224  }
225  else SimpleEvent(g_date->OldDays() + g_date->DayInYear(1, 8), fi_bz_cutting1, false);
226  break;
227  case fi_bz_cutting1: //
228  if (!a_farm->CutToSilage(a_field, 0.0,
229  g_date->DayInYear(30, 9) - g_date->DayInYear())) {
230  SimpleEvent(g_date->Date() + 1, fi_bz_cutting1, true);
231  break;
232  }
233  done = true;
234  break;
235  case fi_bz_cattle_is_out1: // Keep the cattle out there
236  // CattleIsOut() returns false if it is not time to stop grazing
237  if (!m_farm->CattleIsOut(m_field, 0.0, g_date->DayInYear(30, 9) - g_date->DayInYear(), g_date->DayInYear(30, 9))) {
239  break;
240  }
241  done = true;
242  break;
243  // So we are done, and somewhere else the farmer will queue up the start event of the next crop
244  // END OF MAIN THREAD
245  default:
246  g_msg->Warn(WARN_BUG, "FI_BufferZone::Do(): "
247  "Unknown event type! ", "");
248  exit(1);
249  }
250  return done;
251 }

References Farm::CattleIsOut(), Farm::CattleOut(), LE::ClearManagementActionSum(), Farm::CutToSilage(), Calendar::Date(), Calendar::DayInYear(), Farm::DoIt(), Farm::DoIt_prob(), Farm::FA_NPK(), Farm::FA_Slurry(), fi_bz_cattle_is_out1, fi_bz_cutting1, fi_bz_grazing1, fi_bz_npk, fi_bz_slurry, fi_bz_sow, fi_bz_start, FI_BZ_YEARS_AFTER_SOW, g_date, g_msg, LE::GetOwner(), LE::GetPoly(), Farm::GetPreviousTov(), LE::GetRotIndex(), Farm::GetType(), Calendar::GetYearNumber(), Farm::IsStockFarmer(), Crop::m_ev, Crop::m_farm, Crop::m_field, Crop::m_first_date, FarmEvent::m_first_year, FarmEvent::m_lock, FarmEvent::m_next_tov, FarmEvent::m_startday, FarmEvent::m_todo, Calendar::OldDays(), Crop::SimpleEvent(), Farm::SpringSow(), tof_OptimisingFarm, MapErrorMsg::Warn(), and WARN_BUG.

◆ SetUpFarmCategoryInformation()

void FI_BufferZone::SetUpFarmCategoryInformation ( )
inline
98  {
99  const int elements = 2 + (fi_bz_foobar - FI_BZ_BASE);
101 
102  FarmManagementCategory catlist[elements] =
103  {
104  fmc_Others, // zero element unused but must be here
105  fmc_Others, // fi_bz_start = 1, // Compulsory, must always be 1 (one).
106  fmc_Others, // fi_bz_sleep_all_day = FI_BZ_BASE,
107  fmc_Others, // fi_bz_sow,
108  fmc_Fertilizer, // fi_bz_npk,
109  fmc_Fertilizer, // fi_bz_slurry,
110  fmc_Grazing, // fi_bz_grazing1,
111  fmc_Grazing, // fi_bz_cattle_is_out1,
112  fmc_Cutting // fi_bz_cutting1,
113 
114 
115  // no foobar entry
116 
117  };
118  // Iterate over the catlist elements and copy them to vector
119  copy(begin(catlist), end(catlist), back_inserter(m_ManagementCategories));
120 
121  }

References FI_BZ_BASE, fi_bz_foobar, fmc_Cutting, fmc_Fertilizer, fmc_Grazing, fmc_Others, Crop::m_base_elements_no, and Crop::m_ManagementCategories.

Referenced by FI_BufferZone().


The documentation for this class was generated from the following files:
fi_bz_start
Definition: FI_BufferZone.h:66
Farm::FA_Slurry
virtual bool FA_Slurry(LE *a_field, double a_user, int a_days)
Spready slurry on a_field owned by an stock farmer.
Definition: FarmFuncs.cpp:1067
Farm::IsStockFarmer
bool IsStockFarmer(void)
Definition: Farm.h:961
FarmEvent::m_lock
bool m_lock
Definition: Farm.h:384
Farm::CattleIsOut
virtual bool CattleIsOut(LE *a_field, double a_user, int a_days, int a_max)
Generate a 'cattle_out' event for every day the cattle are on a_field.
Definition: FarmFuncs.cpp:2470
LE::ClearManagementActionSum
void ClearManagementActionSum()
clears the management action counters
Definition: Elements.h:247
Farm::CutToSilage
virtual bool CutToSilage(LE *a_field, double a_user, int a_days)
Cut vegetation for silage on a_field.
Definition: FarmFuncs.cpp:1644
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
FI_BZ_YEARS_AFTER_SOW
#define FI_BZ_YEARS_AFTER_SOW
Definition: FI_BufferZone.h:53
LE::GetPoly
int GetPoly(void)
Returns the polyref number for this polygon.
Definition: Elements.h:238
Farm::DoIt_prob
bool DoIt_prob(double a_probability)
Return chance out of 0 to 1.
Definition: Farm.cpp:864
g_date
class Calendar * g_date
Definition: Calendar.cpp:37
Farm::GetPreviousTov
TTypesOfVegetation GetPreviousTov(int a_index)
Definition: Farm.h:966
FI_BufferZone::SetUpFarmCategoryInformation
void SetUpFarmCategoryInformation()
Definition: FI_BufferZone.h:98
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
Farm::GetType
TTypesOfFarm GetType(void)
Definition: Farm.h:956
Crop::m_base_elements_no
int m_base_elements_no
Definition: Farm.h:505
Crop::m_first_date
int m_first_date
Definition: Farm.h:501
FarmEvent::m_startday
int m_startday
Definition: Farm.h:385
Farm::FA_NPK
virtual bool FA_NPK(LE *a_field, double a_user, int a_days)
Apply NPK fertilizer to a_field owned by an stock farmer.
Definition: FarmFuncs.cpp:982
fi_bz_cutting1
Definition: FI_BufferZone.h:73
Crop::SimpleEvent
void SimpleEvent(long a_date, int a_todo, bool a_lock)
Adds an event to this crop management.
Definition: Farm.cpp:747
fi_bz_foobar
Definition: FI_BufferZone.h:74
fmc_Cutting
Definition: LandscapeFarmingEnums.h:1009
fmc_Fertilizer
Definition: LandscapeFarmingEnums.h:1004
fi_bz_sow
Definition: FI_BufferZone.h:68
fi_bz_cattle_is_out1
Definition: FI_BufferZone.h:72
Calendar::Date
long Date(void)
Definition: Calendar.h:57
fmc_Others
Definition: LandscapeFarmingEnums.h:1003
fi_bz_npk
Definition: FI_BufferZone.h:69
fi_bz_slurry
Definition: FI_BufferZone.h:70
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
LE::GetRotIndex
int GetRotIndex(void)
Definition: Elements.h:373
FarmEvent::m_next_tov
TTypesOfVegetation m_next_tov
Definition: Farm.h:390
Crop::m_farm
Farm * m_farm
Definition: Farm.h:498
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
tof_OptimisingFarm
Definition: LandscapeFarmingEnums.h:696
g_msg
MapErrorMsg * g_msg
Definition: MapErrorMsg.cpp:41
FI_BZ_BASE
#define FI_BZ_BASE
Definition: FI_BufferZone.h:55
fmc_Grazing
Definition: LandscapeFarmingEnums.h:1010
fi_bz_grazing1
Definition: FI_BufferZone.h:71
LE::GetOwner
Farm * GetOwner(void)
Definition: Elements.h:256
Calendar::DayInYear
int DayInYear(void)
Definition: Calendar.h:58
Crop::Crop
Crop(TTypesOfVegetation a_tov, TTypesOfCrops a_toc, Landscape *a_L)
Definition: Farm.cpp:733
Crop::m_ev
FarmEvent * m_ev
Definition: Farm.h:500
Farm::CattleOut
virtual bool CattleOut(LE *a_field, double a_user, int a_days)
Start a grazing event on a_field today.
Definition: FarmFuncs.cpp:2368
WARN_BUG
Definition: MapErrorMsg.h:34
FarmManagementCategory
FarmManagementCategory
Definition: LandscapeFarmingEnums.h:1001