ALMaSS  1.2 (after EcoStack, March 2024)
The Animal, Landscape and Man Simulation System
PermanentGrassGrazed.h
Go to the documentation of this file.
1 //
2 // PermanentGrassGrazed.h
3 //
4 /*
5 *******************************************************************************************************
6 Copyright (c) 2011, 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 PermanentGrassGrazed_H
29 #define PermanentGrassGrazed_H
30 
31 #define PGG_BASE 5200
32 #define PGG_CUT_DATE m_field->m_user[0]
33 #define PGG_FERTI_DATE m_field->m_user[1]
34 
35 typedef enum {
36  pgg_start = 1, // Compulsory, start event must always be 1 (one).
51 
52 
53 
55 {
56 public:
57  bool Do( Farm *a_farm, LE *a_field, FarmEvent *a_ev );
58  PermanentGrassGrazed(TTypesOfVegetation a_tov, TTypesOfCrops a_toc, Landscape* a_L) : Crop(a_tov, a_toc, a_L)
59  {
62  }
64  const int elements = 2 + (pgg_foobar - PGG_BASE);
66 
67  FarmManagementCategory catlist[elements] =
68  {
69  fmc_Others, // zero element unused but must be here
70  fmc_Others, //pgg_start = 1, // Compulsory, start event must always be 1 (one).
71  fmc_Cutting, //pgg_cut_to_hay = PGG_BASE,
72  fmc_Grazing, //pgg_cattle_out1,
73  fmc_Grazing, //pgg_cattle_out2,
74  fmc_Grazing, //pgg_cattle_is_out,
75  fmc_Cutting, //pgg_cut_weeds,
76  fmc_Herbicide, //pgg_herbicide,
77  fmc_Fertilizer, //pgg_ferti_s,
78  fmc_Fertilizer, //pgg_ferti_p,
79  fmc_Others, //pgg_raking1,
80  fmc_Others, //pgg_raking2,
81  fmc_Others, //pgg_compress_straw,
82  fmc_Others //pgg_wait,
83  // No foobar entry
84  };
85  // Iterate over the catlist elements and copy them to vector
86  copy(begin(catlist), end(catlist), back_inserter(m_ManagementCategories));
87  }
88 };
89 
90 #endif // PermanentGrassGrazed_H
LE::GetMDates
int GetMDates(int a, int b)
Definition: Elements.h:405
LE::SetMDates
void SetMDates(int a, int b, int c)
Definition: Elements.h:406
Farm::HerbicideTreat
virtual bool HerbicideTreat(LE *a_field, double a_user, int a_days)
Apply herbicide to a_field.
Definition: FarmFuncs.cpp:2025
Farm::IsStockFarmer
bool IsStockFarmer(void)
Definition: Farm.h:961
LE::SetLastSownVeg
void SetLastSownVeg(TTypesOfVegetation a_tov)
Records the last vegetation type to be sown.
Definition: Elements.h:357
FarmEvent::m_lock
bool m_lock
Definition: Farm.h:384
pgg_cut_weeds
Definition: PermanentGrassGrazed.h:41
FarmEvent
A struct to hold the information required to trigger a farm event.
Definition: Farm.h:372
LE::GetMConstants
int GetMConstants(int a)
Definition: Elements.h:407
pgg_cut_to_hay
Definition: PermanentGrassGrazed.h:37
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::FP_NPK
virtual bool FP_NPK(LE *a_field, double a_user, int a_days)
Apply NPK fertilizer, on a_field owned by an arable farmer.
Definition: FarmFuncs.cpp:645
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
cfg_fungi_app_prop1
CfgFloat cfg_fungi_app_prop1
FarmEvent::m_first_year
bool m_first_year
Definition: Farm.h:386
g_date
class Calendar * g_date
Definition: Calendar.cpp:37
pgg_cattle_out1
Definition: PermanentGrassGrazed.h:38
fmc_Herbicide
Definition: LandscapeFarmingEnums.h:1006
PermanentGrassGrazed::SetUpFarmCategoryInformation
void SetUpFarmCategoryInformation()
Definition: PermanentGrassGrazed.h:63
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
Farm::CutToHay
virtual bool CutToHay(LE *a_field, double a_user, int a_days)
Carry out hay cutting on a_field.
Definition: FarmFuncs.cpp:1607
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
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
fmc_Cutting
Definition: LandscapeFarmingEnums.h:1009
Farm::Prob_multiplier
virtual double Prob_multiplier()
Definition: Farm.h:778
Landscape
The landscape class containing all environmental and topographical data.
Definition: Landscape.h:142
fmc_Fertilizer
Definition: LandscapeFarmingEnums.h:1004
PermanentGrassGrazed::PermanentGrassGrazed
PermanentGrassGrazed(TTypesOfVegetation a_tov, TTypesOfCrops a_toc, Landscape *a_L)
Definition: PermanentGrassGrazed.h:58
cfg_herbi_app_prop
CfgFloat cfg_herbi_app_prop
Calendar::Date
long Date(void)
Definition: Calendar.h:57
cfg_ins_app_prop1
CfgFloat cfg_ins_app_prop1
Farm::HayBailing
virtual bool HayBailing(LE *a_field, double a_user, int a_days)
Carry out hay bailing on a_field.
Definition: FarmFuncs.cpp:1507
fmc_Others
Definition: LandscapeFarmingEnums.h:1003
pgg_ferti_s
Definition: PermanentGrassGrazed.h:43
PermanentGrassGrazed
Definition: PermanentGrassGrazed.h:54
PGG_BASE
#define PGG_BASE
Definition: PermanentGrassGrazed.h:31
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
pgg_compress_straw
Definition: PermanentGrassGrazed.h:47
pgg_raking1
Definition: PermanentGrassGrazed.h:45
pgg_wait
Definition: PermanentGrassGrazed.h:48
pgg_cattle_is_out
Definition: PermanentGrassGrazed.h:40
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
pgg_raking2
Definition: PermanentGrassGrazed.h:46
TTypesOfCrops
TTypesOfCrops
Definition: LandscapeFarmingEnums.h:781
PermanentGrassGrazedToDo
PermanentGrassGrazedToDo
Definition: PermanentGrassGrazed.h:35
tof_OptimisingFarm
Definition: LandscapeFarmingEnums.h:696
LE
Definition: Elements.h:86
pgg_foobar
Definition: PermanentGrassGrazed.h:49
Crop::m_last_date
int m_last_date
Definition: Farm.h:503
g_msg
MapErrorMsg * g_msg
Definition: MapErrorMsg.cpp:41
fmc_Grazing
Definition: LandscapeFarmingEnums.h:1010
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
PermanentGrassGrazed::Do
bool Do(Farm *a_farm, LE *a_field, FarmEvent *a_ev)
Definition: PermanentGrassGrazed.cpp:37
CfgFloat
Double configurator entry class.
Definition: Configurator.h:126
Calendar::DayInYear
int DayInYear(void)
Definition: Calendar.h:58
pgg_herbicide
Definition: PermanentGrassGrazed.h:42
PGG_CUT_DATE
#define PGG_CUT_DATE
Definition: PermanentGrassGrazed.h:32
pgg_cattle_out2
Definition: PermanentGrassGrazed.h:39
LE::SetMConstants
void SetMConstants(int a, int c)
Definition: Elements.h:408
pgg_start
Definition: PermanentGrassGrazed.h:36
Crop::ChooseNextCrop
void ChooseNextCrop(int a_no_dates)
Chooses the next crop to grow in a field.
Definition: Farm.cpp:756
Farm::HayTurning
virtual bool HayTurning(LE *a_field, double a_user, int a_days)
Carry out hay turning on a_field.
Definition: FarmFuncs.cpp:1491
PGG_FERTI_DATE
#define PGG_FERTI_DATE
Definition: PermanentGrassGrazed.h:33
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
pgg_ferti_p
Definition: PermanentGrassGrazed.h:44
WARN_BUG
Definition: MapErrorMsg.h:34
FarmManagementCategory
FarmManagementCategory
Definition: LandscapeFarmingEnums.h:1001
cfg_greg_app_prop
CfgFloat cfg_greg_app_prop
Farm::CutWeeds
virtual bool CutWeeds(LE *a_field, double a_user, int a_days)
Carry out weed topping on a_field.
Definition: FarmFuncs.cpp:1629