PTShrubPastures.h

Go to the documentation of this file.

 
//
// PTShrubPastures.h
//
/*
*******************************************************************************************************
Copyright (c) 2024, Christopher John Topping, University of Aarhus
All rights reserved.
 
Redistribution and use in source and binary forms, with or without modification, are permitted provided
that the following conditions are met:
 
Redistributions of source code must retain the above copyright notice, this list of conditions and the
following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
the following disclaimer in the documentation and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
********************************************************************************************************
*/
 
 
#ifndef PTSHRUBPASTURES_H
#define PTSHRUBPASTURES_H
 
#define PTSHRUBPASTURES_BASE 31000
 
#define PT_SP1_CATTLEOUT_DATE a_field->m_user[1]
#define PT_SP2_CATTLEOUT_DATE a_field->m_user[2]
#define PT_SP3_CATTLEOUT_DATE a_field->m_user[3]
#define PT_SP_YEARS_AFTER_PLOUGH a_field->m_user[4]
 
typedef enum {
    pt_sp_start = 1, // Compulsory, must always be 1 (one).
    pt_sp_sleep_all_day = PTSHRUBPASTURES_BASE,
    pt_sp_cattle_out1,
    pt_sp_cattle_is_out1,
    pt_sp_spring_plough,
    pt_sp_cattle_out2,
    pt_sp_cattle_is_out2,
    pt_sp_cattle_out3,
    pt_sp_cattle_is_out3,
    pt_sp_wait,
    pt_sp_foobar,
 
} PTShrubPasturesToDo;
 
 
class PTShrubPastures: public Crop
{
 public:
   virtual bool  Do( Farm *a_farm, LE *a_field, FarmEvent *a_ev );
   PTShrubPastures(TTypesOfVegetation a_tov, TTypesOfCrops a_toc, Landscape* a_L) : Crop(a_tov, a_toc, a_L)
   {
        // When we start it off, the first possible date for a farm operation is 31th November
        // This information is used by other crops when they decide how much post processing of 
        // the management is allowed after harvest before the next crop starts.
        m_first_date=g_date->DayInYear( 10,1 );//Last possible date to do the first operation, i.e. plough or sow
        SetUpFarmCategoryInformation();
   }
   void SetUpFarmCategoryInformation() {
       const int elements = 2 + (pt_sp_foobar - PTSHRUBPASTURES_BASE);
       m_base_elements_no = PTSHRUBPASTURES_BASE - 2;
 
       FarmManagementCategory catlist[elements] =
       {
            fmc_Others,         // zero element unused but must be here 
            fmc_Others,         //pt_sp_start = 1, // Compulsory, must always be 1 (one).
            fmc_Others,         //pt_sp_sleep_all_day = PTSHRUBPASTURES_BASE,
            fmc_Grazing,        //pt_sp_cattle_out1,
            fmc_Grazing,        //pt_sp_cattle_is_out1,
            fmc_Grazing,        //pt_sp_spring_plough,
            fmc_Grazing,        //pt_sp_cattle_out2,
            fmc_Grazing,        //pt_sp_cattle_is_out2,
            fmc_Grazing,        //pt_sp_cattle_out3,
            fmc_Grazing,        //pt_sp_cattle_is_out3,
            fmc_Others,         //pt_sp_wait,
 
           // no foobar entry   
 
       };
       // Iterate over the catlist elements and copy them to vector             
       copy(begin(catlist), end(catlist), back_inserter(m_ManagementCategories));
 
   }
};
 
#endif // PTSHRUBPASTURES_H