Calendar Class Reference

#include <calendar.h>

Public Member Functions
void	Reset (void)
bool	TickMinute (void)
bool	TickMinute10 (void)
bool	TickHour (void)
void	Tick (void)
long	Date (void)
int	DayInYear (void)
long	OldDays (void)
long	GlobalDate (int a_day, int a_month, int a_year)
int	DayLength (void)
int	DayLength (int a_day_in_year)
int	GetFirstYear (void)
int	GetLastYear (void)
int	GetYear (void)
int	GetYearNumber (void)
int	GetMonth (void)
int	GetMinute (void)
int	GetHour (void)
int	GetDayInMonth (void)
double	GetDaylightProportion (void)
bool	JanFirst (void)
bool	MarchFirst (void)
void	SetFirstYear (int a_year)
void	SetLastYear (int a_year)
bool	ValidDate (int a_day, int a_month)
int	DayInYear (int a_day, int a_month)
	Calendar (void)

Private Attributes
long	m_date
long	m_olddays
int	m_firstyear
int	m_lastyear
int	m_day_in_month
int	m_day_in_year
int	m_month
int	m_year
int	m_simulationyear
int	m_todayslength
double	m_daylightproportion
int	m_minutes
int	m_hours
bool	m_janfirst
bool	m_marchfirst

Static Private Attributes
static int	m_daylength []
	The length of the day between sun up and sun down im minutes (DK - Jutland) More...

Detailed Description

Definition at line 38 of file calendar.h.

Constructor & Destructor Documentation

Calendar()

Calendar::Calendar

(

void

)

Definition at line 55 of file calendar.cpp.

{
  Reset();
}

References Reset().

Member Function Documentation

Date()

long Calendar::Date ( void  )

inline

Definition at line 57 of file calendar.h.

{ return m_date; }

References m_date.

Referenced by Farm::BulbHarvest(), Farm::BurnStrawStubble(), Rabbit_Population_Manager::CheckForRabbitBreedingConditions(), Farm::CheckRotationManagementLoop(), Farm::CutToHay(), VegElement::DoDevelopment(), UnsprayedFieldMargin::DoDevelopment(), Weather::GetSnow(), Farm::HandleEvents(), OptimisingFarm::HandleEvents(), Farm::Harvest(), OptimisingFarm::Harvest(), Farm::HarvestLong(), Farm::HayBailing(), Farm::HayTurning(), Farm::InitiateManagement(), Farm::RowCultivation(), VegElement::SetGrowthPhase(), Farm::StrawChopping(), Farm::Strigling(), Farm::StriglingSow(), Farm::StubbleHarrowing(), Landscape::SupplyGlobalDate(), and Weather::Tick().

DayInYear() [1/2]

int Calendar::DayInYear	(	int	a_day,
		int	a_month
	)

Definition at line 96 of file calendar.cpp.

{
  const int m_monthsum[12] = {
    0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334 };
 
  return m_monthsum[ a_month - 1 ] + a_day - 1;
}

DayInYear() [2/2]

int Calendar::DayInYear ( void  )

inline

Definition at line 58 of file calendar.h.

{ return m_day_in_year; }

References m_day_in_year.

Referenced by VegElement::CalcGooseForageResources(), Farm::CattleIsOut(), Farm::CattleIsOutLow(), Rabbit_Population_Manager::CheckForRabbitBreedingConditions(), Crop::ChooseNextCrop(), RoadsideVerge::DoDevelopment(), WaterBufferZone::DoDevelopment(), Orchard::DoDevelopment(), OrchardBand::DoDevelopment(), MownGrass::DoDevelopment(), Landscape::DumpMapInfoByArea(), VegElement::ForceGrowthInitialize(), VegElement::ForceGrowthTest(), LE::GetGooseNos(), LE::GetGooseNosToday(), LE::GetGooseNosTodayTimed(), LE::GetGooseSpNosToday(), LE::GetGooseSpNosTodayTimed(), LE::GetQuarryNos(), GlobalDate(), VegElement::PollenNectarPhenologyCalculation(), VegElement::ReduceVeg_Extended(), VegElement::ResetGeese(), Landscape::SupplyDayInYear(), Landscape::Tick(), and Weather::Tick().

DayLength() [1/2]

int Calendar::DayLength

(

int

a_day_in_year

)

Definition at line 67 of file calendar.cpp.

{
  if ( a_day_in_year<0 || a_day_in_year>364 ) {
    g_msg->Warn( WARN_BUG, "Calendar::DayLength(): Day outside a year!",
      "" );
    exit(1);
  }
  return m_daylength[ a_day_in_year ];
}

References g_msg, m_daylength, MapErrorMsg::Warn(), and WARN_BUG.

DayLength() [2/2]

int Calendar::DayLength ( void  )

inline

Definition at line 63 of file calendar.h.

{ return m_todayslength; }

References m_todayslength.

Referenced by Landscape::SupplyDaylength().

GetDayInMonth()

int Calendar::GetDayInMonth ( void  )

inline

Definition at line 72 of file calendar.h.

{ return m_day_in_month; }

References m_day_in_month.

Referenced by Landscape::SupplyDayInMonth(), and Landscape::Tick().

GetDaylightProportion()

double Calendar::GetDaylightProportion ( void  )

inline

Definition at line 73 of file calendar.h.

{ return m_daylightproportion; }

References m_daylightproportion.

Referenced by Landscape::SupplyDaylightProp(), and Landscape::SupplyNightProp().

GetFirstYear()

int Calendar::GetFirstYear ( void  )

inline

Definition at line 65 of file calendar.h.

{ return m_firstyear; }

References m_firstyear.

GetHour()

int Calendar::GetHour ( void  )

inline

Definition at line 71 of file calendar.h.

{ return m_hours; }

References m_hours.

Referenced by LargeRoad::GetTrafficLoad(), SmallRoad::GetTrafficLoad(), and Landscape::SupplyHour().

GetLastYear()

int Calendar::GetLastYear ( void  )

inline

Definition at line 66 of file calendar.h.

{ return m_lastyear; }

References m_lastyear.

Referenced by Weather::Weather().

GetMinute()

int Calendar::GetMinute ( void  )

inline

Definition at line 70 of file calendar.h.

{ return m_minutes; }

References m_minutes.

Referenced by Landscape::SupplyMinute().

GetMonth()

int Calendar::GetMonth ( void  )

inline

Definition at line 69 of file calendar.h.

{ return m_month + 1; }

References m_month.

Referenced by Pond::CalcLarvalFood(), RoadsideVerge::DoDevelopment(), PesticideMap::DumpPMap(), LargeRoad::GetTrafficLoad(), SmallRoad::GetTrafficLoad(), and Landscape::SupplyMonth().

GetYear()

int Calendar::GetYear ( void  )

inline

Definition at line 67 of file calendar.h.

{ return m_year; }

References m_year.

Referenced by PesticideMap::DumpPMap(), Landscape::SupplyYear(), and Landscape::VegDump().

GetYearNumber()

int Calendar::GetYearNumber ( void  )

inline

Definition at line 68 of file calendar.h.

{ return m_simulationyear; }

References m_simulationyear.

Referenced by OptimisingFarm::ActualProfit(), Rabbit_Population_Manager::CheckForRabbitBreedingConditions(), OptimisingFarm::ChooseDecisionMode(), Crop::ChooseNextCrop(), FarmManager::PrintFinalResults(), Landscape::SupplyYearNumber(), and Landscape::Tick().

GlobalDate()

long Calendar::GlobalDate	(	int	a_day,
		int	a_month,
		int	a_year
	)

Definition at line 61 of file calendar.cpp.

{
  return m_olddays + DayInYear( a_day, a_month) + a_year*365;
}

References DayInYear(), and m_olddays.

JanFirst()

bool Calendar::JanFirst ( void  )

inline

Definition at line 74 of file calendar.h.

{ return m_janfirst; }

References m_janfirst.

Referenced by RoadsideVerge::DoDevelopment(), WaterBufferZone::DoDevelopment(), Orchard::DoDevelopment(), MownGrass::DoDevelopment(), and Landscape::Tick().

MarchFirst()

bool Calendar::MarchFirst ( void  )

inline

Definition at line 75 of file calendar.h.

{ return m_marchfirst; }

References m_marchfirst.

Referenced by Landscape::Tick().

OldDays()

long Calendar::OldDays ( void  )

inline

Definition at line 60 of file calendar.h.

{ return m_olddays; }

References m_olddays.

Referenced by Landscape::DumpMapInfoByArea().

Reset()

void Calendar::Reset

(

void

)

Definition at line 40 of file calendar.cpp.

{
  m_date         = 0;
  m_olddays      = 0;
  m_day_in_month = 1;
  m_minutes      = 0;
  m_hours        = 0;
  m_day_in_year  = 0; // [0..364]
  m_month        = 0; // [0..11]
  m_year         = m_firstyear;
  m_simulationyear = 0;
  m_janfirst     = true;
  m_marchfirst   = false;
}

References m_date, m_day_in_month, m_day_in_year, m_firstyear, m_hours, m_janfirst, m_marchfirst, m_minutes, m_month, m_olddays, m_simulationyear, and m_year.

Referenced by Calendar(), Landscape::Landscape(), and Weather::Weather().

SetFirstYear()

void Calendar::SetFirstYear ( int  a_year )

inline

Definition at line 76 of file calendar.h.

{ m_firstyear = a_year; }

References m_firstyear.

Referenced by Weather::Weather().

SetLastYear()

void Calendar::SetLastYear ( int  a_year )

inline

Definition at line 77 of file calendar.h.

{ m_lastyear = a_year; }

References m_lastyear.

Referenced by Weather::Weather().

Tick()

void Calendar::Tick

(

void

)

Definition at line 141 of file calendar.cpp.

{
  const int m_monthlength[12] = {
    31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 };
  const int m_maxmonth = 11;
 
  m_minutes    = 0;
  m_hours      = 0;
  m_date++;
  m_day_in_year++;
  m_day_in_month++;
  m_janfirst   = false;
  m_marchfirst = false;
 
  if ( m_day_in_month > m_monthlength[ m_month ])
  {
    m_day_in_month = 1;
    m_month++;
    if ( m_month == 2 )
      // March 1st.
      m_marchfirst = true;
  }
 
  if ( m_month > m_maxmonth )
  {
    m_month = 0;
    m_year++;
    m_simulationyear++;
    m_olddays += 365;
    m_janfirst = true;
    m_day_in_year = 0;
  }
  m_todayslength = m_daylength[ m_day_in_year ];
  m_daylightproportion = m_daylength[m_day_in_year] / 1440.0;
}

References m_date, m_day_in_month, m_day_in_year, m_daylength, m_daylightproportion, m_hours, m_janfirst, m_marchfirst, m_minutes, m_month, m_olddays, m_simulationyear, m_todayslength, and m_year.

Referenced by Landscape::Tick().

TickHour()

bool Calendar::TickHour

(

void

)

Definition at line 128 of file calendar.cpp.

{
    bool dotick = false;
 
  if ( ++m_hours > 23 ) {
    m_minutes = 0;
    m_hours   = 0;
    dotick = true;
  }
  return dotick;
}

References m_hours, and m_minutes.

TickMinute()

bool Calendar::TickMinute

(

void

)

Definition at line 106 of file calendar.cpp.

{
    bool dotick = false;
 
    if (m_minutes++ > 59) {
        m_minutes = 0;
        dotick = true;
    }
    return dotick;
}

References m_minutes.

TickMinute10()

bool Calendar::TickMinute10

(

void

)

Definition at line 117 of file calendar.cpp.

{
    bool dotick = false;
    m_minutes += 10;
    if (m_minutes > 59) {
        m_minutes = 0;
        dotick = true;
    }
    return dotick;
}

References m_minutes.

ValidDate()

bool Calendar::ValidDate	(	int	a_day,
		int	a_month
	)

Definition at line 79 of file calendar.cpp.

{
  const int m_monthlength[12] = {
    31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 };
 
  if ( a_month < 1  ||
       a_month > 12 ||
       a_day < 1    ||
       a_day > m_monthlength[ a_month - 1 ] ) {
    return false;
  } else {
    return true;
  }
}

Member Data Documentation

m_date

long Calendar::m_date

private

Definition at line 86 of file calendar.h.

Referenced by Date(), Reset(), and Tick().

m_day_in_month

int Calendar::m_day_in_month

private

Definition at line 90 of file calendar.h.

Referenced by GetDayInMonth(), Reset(), and Tick().

m_day_in_year

int Calendar::m_day_in_year

private

Definition at line 91 of file calendar.h.

Referenced by DayInYear(), Reset(), and Tick().

m_daylength

int Calendar::m_daylength

staticprivate

The length of the day between sun up and sun down im minutes (DK - Jutland)

Definition at line 102 of file calendar.h.

Referenced by DayLength(), and Tick().

m_daylightproportion

double Calendar::m_daylightproportion

private

Definition at line 96 of file calendar.h.

Referenced by GetDaylightProportion(), and Tick().

m_firstyear

int Calendar::m_firstyear

private

Definition at line 88 of file calendar.h.

Referenced by GetFirstYear(), Reset(), and SetFirstYear().

m_hours

int Calendar::m_hours

private

Definition at line 98 of file calendar.h.

Referenced by GetHour(), Reset(), Tick(), and TickHour().

m_janfirst

bool Calendar::m_janfirst

private

Definition at line 99 of file calendar.h.

Referenced by JanFirst(), Reset(), and Tick().

m_lastyear

int Calendar::m_lastyear

private

Definition at line 89 of file calendar.h.

Referenced by GetLastYear(), and SetLastYear().

m_marchfirst

bool Calendar::m_marchfirst

private

Definition at line 100 of file calendar.h.

Referenced by MarchFirst(), Reset(), and Tick().

m_minutes

int Calendar::m_minutes

private

Definition at line 97 of file calendar.h.

Referenced by GetMinute(), Reset(), Tick(), TickHour(), TickMinute(), and TickMinute10().

m_month

int Calendar::m_month

private

Definition at line 92 of file calendar.h.

Referenced by GetMonth(), Reset(), and Tick().

m_olddays

long Calendar::m_olddays

private

Definition at line 87 of file calendar.h.

Referenced by GlobalDate(), OldDays(), Reset(), and Tick().

m_simulationyear

int Calendar::m_simulationyear

private

Definition at line 94 of file calendar.h.

Referenced by GetYearNumber(), Reset(), and Tick().

m_todayslength

int Calendar::m_todayslength

private

Definition at line 95 of file calendar.h.

Referenced by DayLength(), and Tick().

m_year

int Calendar::m_year

private

Definition at line 93 of file calendar.h.

Referenced by GetYear(), Reset(), and Tick().

---

The documentation for this class was generated from the following files:

• C:/Repo/ALMaSS_all/Landscape/calendar.h
• C:/Repo/ALMaSS_all/Landscape/calendar.cpp
• C:/Repo/ALMaSS_all/Landscape/daylength.h