File failed to load: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/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
PTBeans Class Reference

PTBeans class
. More...

#include <PTBeans.h>

Inheritance diagram for PTBeans:
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...
 
 PTBeans (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

PTBeans class
.

See PTBeans.h::PTBeansToDo for a complete list of all possible events triggered codes by the Beans 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

◆ PTBeans()

PTBeans::PTBeans ( TTypesOfVegetation  a_tov,
TTypesOfCrops  a_toc,
Landscape a_L 
)
inline
82  : Crop(a_tov, a_toc, a_L)
83  {
84  // When we start it off, the first possible date for a farm operation is 30th November
85  // This information is used by other crops when they decide how much post processing of
86  // the management is allowed after harvest before the next crop starts.
87  m_first_date=g_date->DayInYear( 30,11 );
89  }

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

Member Function Documentation

◆ Do()

bool PTBeans::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 m_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 TemporalGrassGrazed.

Reimplemented from Crop.

54 {
55  /******************** This block can be added to the top of all Crop::Do methods ***********************************************/
56  m_farm = a_farm; // These assignments are necessary, not for this method but for related event calls
57  m_field = a_field;
58  m_ev = a_ev;
59  bool done = false; // The boolean value done indicates when we are totally finished with this plan (i.e. it is set to true).
60  int d1 = 0;
61  TTypesOfVegetation l_tov = tov_PTBeans; // The current type - change to match the crop you have
62 /**********************************************To Here *************************************************************************/
63 
64  // Depending what event has occured jump to the correct bit of code
65  switch (m_ev->m_todo)
66  {
67  case pt_bns_start:
68  {
70 
71  m_last_date = g_date->DayInYear(31, 8); // Should match the last flexdate below
72  //Create a 2d array of 1 plus the number of operations you use. Change only 4+1 to what you need in the line below
73  std::vector<std::vector<int>> flexdates(1 + 1, std::vector<int>(2, 0));
74  // Set up the date management stuff
75  // Start and stop dates for all events after harvest
76  flexdates[0][1] = g_date->DayInYear(31, 8); // last possible day of harvest - this is in effect day before the earliest date that a following crop can use
77 
78  flexdates[1][0] = -1; // This date will be moved back as far as necessary and potentially to flexdates 1 (start op 1)
79  flexdates[1][1] = g_date->DayInYear(31, 8); // This date will be moved back as far as necessary and potentially to flexdates 1 (end op 1)
80 
81  // Below if this is a spring crop use 365, otherwise set this to 0, second parameter is fixed, and the third is the start up operation in the first year
82  int isSpring = 0;
83  if (StartUpCrop(isSpring, flexdates, int(pt_bns_wait))) break;
84 
85  // End single block date checking code. Please see next line comment as well.
86  // Reinit d1 to first possible starting date.
87  d1 = g_date->OldDays() + g_date->DayInYear(1, 11) + isSpring;
88  // OK, let's go.
89  // Here we queue up the first event which changes dependent on whether it is a forced spring sow or not
91  break;
92  }
93  break;
94 
95  // This is the first real farm operation
97  if (!m_farm->StubbleHarrowing(m_field, 0.0, g_date->DayInYear(30, 11) - g_date->DayInYear())) {
99  break;
100  }
102  break;
103 
105  if (!m_farm->AutumnPlough(m_field, 0.0, g_date->DayInYear(1, 12) - g_date->DayInYear())) {
107  break;
108  }
109  if (m_farm->IsStockFarmer()) //Stock Farmer
110  {
112  }
113  else SimpleEvent_(g_date->Date() + 1, pt_bns_ferti_p1, false, m_farm, m_field);
114  break;
115  case pt_bns_ferti_s1:
116  if (!m_farm->FA_NPK(m_field, 0.0, g_date->DayInYear(2, 12) - g_date->DayInYear())) {
118  break;
119  }
121  break;
122  case pt_bns_ferti_p1:
123  if (!m_farm->FP_NPK(m_field, 0.0, g_date->DayInYear(2, 12) - g_date->DayInYear())) {
125  break;
126  }
128  break;
130  if (!m_farm->AutumnHarrow(m_field, 0.0, g_date->DayInYear(3, 12) - g_date->DayInYear())) {
132  break;
133  }
135  break;
136  case pt_bns_autumn_sow:
137  if (!m_farm->AutumnSow(m_field, 0.0, g_date->DayInYear(4, 12) - g_date->DayInYear())) {
139  break;
140  }
141  SimpleEvent_(g_date->OldDays() + g_date->DayInYear(1, 3) + 365, pt_bns_wait, false, m_farm, m_field);
142  break;
143 
144  case pt_bns_wait:
146  break;
147  case pt_bns_harvest:
148  if (!m_farm->Harvest(m_field, 0.0, m_field->GetMDates(1, 0) - g_date->DayInYear())) {
150  break;
151  }
152  done = true;
153  break;
154  // End of Thread
155  default:
156  g_msg->Warn(WARN_BUG, "PTBeans::Do(): "
157  "Unknown event type! ", "");
158  exit(1);
159  }
160  return done;
161 }

References Farm::AutumnHarrow(), Farm::AutumnPlough(), Farm::AutumnSow(), LE::ClearManagementActionSum(), Calendar::Date(), Calendar::DayInYear(), Farm::FA_NPK(), Farm::FP_NPK(), g_date, g_msg, LE::GetMDates(), Farm::Harvest(), Farm::IsStockFarmer(), Crop::m_ev, Crop::m_farm, Crop::m_field, Crop::m_last_date, FarmEvent::m_todo, Calendar::OldDays(), pt_bns_autumn_harrow, pt_bns_autumn_plough, pt_bns_autumn_sow, pt_bns_ferti_p1, pt_bns_ferti_s1, pt_bns_harvest, pt_bns_start, pt_bns_stubble_harrow, pt_bns_wait, Crop::SimpleEvent(), Crop::SimpleEvent_(), Crop::StartUpCrop(), Farm::StubbleHarrowing(), tov_PTBeans, MapErrorMsg::Warn(), and WARN_BUG.

◆ SetUpFarmCategoryInformation()

void PTBeans::SetUpFarmCategoryInformation ( )
inline
90  {
91  const int elements = 2 + (pt_bns_foobar - PTBEANS_BASE);
93 
94  FarmManagementCategory catlist[elements] =
95  {
96  fmc_Others, // zero element unused but must be here
97  fmc_Others, //pt_bns_start = 1, // Compulsory, must always be 1 (one).
98  fmc_Others, //pt_bns_sleep_all_day = PTBEANS_BASE,
99  fmc_Cultivation, //pt_bns_stubble_harrow,
100  fmc_Cultivation, //pt_bns_autumn_plough,
101  fmc_Fertilizer, //pt_bns_ferti_p1, // NPK
102  fmc_Fertilizer, //pt_bns_ferti_s1,
103  fmc_Cultivation, //pt_bns_autumn_harrow,
104  fmc_Others, //pt_bns_autumn_sow,
105  fmc_Others, //pt_bns_wait,
106  fmc_Harvest, //pt_bns_harvest,
107 
108  // no foobar entry
109 
110  };
111  // Iterate over the catlist elements and copy them to vector
112  copy(begin(catlist), end(catlist), back_inserter(m_ManagementCategories));
113 
114  }

References fmc_Cultivation, fmc_Fertilizer, fmc_Harvest, fmc_Others, Crop::m_base_elements_no, Crop::m_ManagementCategories, pt_bns_foobar, and PTBEANS_BASE.

Referenced by PTBeans().


The documentation for this class was generated from the following files:
LE::GetMDates
int GetMDates(int a, int b)
Definition: Elements.h:405
PTBeans::SetUpFarmCategoryInformation
void SetUpFarmCategoryInformation()
Definition: PTBeans.h:90
Farm::IsStockFarmer
bool IsStockFarmer(void)
Definition: Farm.h:961
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
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
tov_PTBeans
Definition: LandscapeFarmingEnums.h:322
g_date
class Calendar * g_date
Definition: Calendar.cpp:37
pt_bns_stubble_harrow
Definition: PTBeans.h:58
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
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::SimpleEvent
void SimpleEvent(long a_date, int a_todo, bool a_lock)
Adds an event to this crop management.
Definition: Farm.cpp:747
pt_bns_autumn_sow
Definition: PTBeans.h:63
fmc_Fertilizer
Definition: LandscapeFarmingEnums.h:1004
pt_bns_harvest
Definition: PTBeans.h:65
pt_bns_autumn_harrow
Definition: PTBeans.h:62
Calendar::Date
long Date(void)
Definition: Calendar.h:57
fmc_Cultivation
Definition: LandscapeFarmingEnums.h:1008
fmc_Others
Definition: LandscapeFarmingEnums.h:1003
Calendar::OldDays
long OldDays(void)
Definition: Calendar.h:60
pt_bns_start
Definition: PTBeans.h:56
MapErrorMsg::Warn
void Warn(MapErrorState a_level, std::string a_msg1, std::string a_msg2)
Definition: MapErrorMsg.cpp:69
Crop::StartUpCrop
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 a...
Definition: Farm.cpp:652
pt_bns_autumn_plough
Definition: PTBeans.h:59
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
pt_bns_wait
Definition: PTBeans.h:64
FarmEvent::m_todo
int m_todo
Definition: Farm.h:388
Crop::m_last_date
int m_last_date
Definition: Farm.h:503
Farm::AutumnPlough
virtual bool AutumnPlough(LE *a_field, double a_user, int a_days)
Carry out a ploughing event in the autumn on a_field.
Definition: FarmFuncs.cpp:212
g_msg
MapErrorMsg * g_msg
Definition: MapErrorMsg.cpp:41
Farm::AutumnHarrow
virtual bool AutumnHarrow(LE *a_field, double a_user, int a_days)
Carry out a harrow event in the autumn on a_field.
Definition: FarmFuncs.cpp:285
TTypesOfVegetation
TTypesOfVegetation
Values that represent the types of vegetation that are represented in ALMaSS.
Definition: LandscapeFarmingEnums.h:192
pt_bns_foobar
Definition: PTBeans.h:66
pt_bns_ferti_s1
Definition: PTBeans.h:61
Farm::AutumnSow
virtual bool AutumnSow(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 autumn on a_field.
Definition: FarmFuncs.cpp:360
pt_bns_ferti_p1
Definition: PTBeans.h:60
fmc_Harvest
Definition: LandscapeFarmingEnums.h:1012
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
WARN_BUG
Definition: MapErrorMsg.h:34
FarmManagementCategory
FarmManagementCategory
Definition: LandscapeFarmingEnums.h:1001
Farm::StubbleHarrowing
virtual bool StubbleHarrowing(LE *a_field, double a_user, int a_days)
Carry out stubble harrowing on a_field.
Definition: FarmFuncs.cpp:1523
Crop::SimpleEvent_
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.
Definition: Farm.cpp:751
PTBEANS_BASE
#define PTBEANS_BASE
Definition: PTBeans.h:45