Partridge_Communication Class Reference

Used for messaging. More...

#include <Partridge_Communication.h>

Public Member Functions
void	ClearData (PartridgeCommunicationData *pc_data)
	Void data. More...
bool	PassMessage (PartridgeCommunicationData *pc_data, TypeOfPartridge_Communication pc)
	Pass a message. More...

Detailed Description

Used for messaging.

Messages are passed between birds, and this a common cause of bugs if the information passed in inconsistent. This class therefore has two purposes - collecting messaging code together for ease of overview, and as a debug function.

Definition at line 100 of file Partridge_Communication.h.

Member Function Documentation

ClearData()

void Partridge_Communication::ClearData

(

PartridgeCommunicationData *

pc_data

)

Void data.

Just makes sure that all message fields are empty. Used before putting new data in.

Definition at line 66 of file Partridge_Communication.cpp.

                                                                            {
  pc_data->m_clutch=NULL;
  pc_data->m_chick=NULL;
  pc_data->m_chick2=NULL;
  pc_data->m_male=NULL;
  pc_data->m_female=NULL;
  pc_data->m_covey=NULL;
  pc_data->m_HaveTerritory=false;
  pc_data->m_boolean=false;
  pc_data->m_int=0;
  pc_data->m_float=0;
}

References PartridgeCommunicationData::m_boolean, PartridgeCommunicationData::m_chick, PartridgeCommunicationData::m_chick2, PartridgeCommunicationData::m_clutch, PartridgeCommunicationData::m_covey, PartridgeCommunicationData::m_female, PartridgeCommunicationData::m_float, PartridgeCommunicationData::m_HaveTerritory, PartridgeCommunicationData::m_int, and PartridgeCommunicationData::m_male.

PassMessage()

bool Partridge_Communication::PassMessage	(	PartridgeCommunicationData *	pc_data,
		TypeOfPartridge_Communication	pc
	)

Pass a message.

This passes messages listed in the TypeOfPartridge_Communication enum. It is a place that errors can be trapped but is not strictly necessary. Data is passed in PartridgeCommunicationData which can be checked agains the sender and the receiver information if __PAR_PCDEBUG is enabled.
This complex method is not really necessary, but it is a wonderful place to trap communication errors. If run-times really get to be a problem, then it might be worth dispensing with this nicety.

Definition at line 86 of file Partridge_Communication.cpp.

                                                                                                                {
    switch (pc) {
    case pcomm_KillChick:
      #ifdef __PAR_PCDEBUG
      if (pc_data->m_chick->GetObjectType() != pob_Chick) {
        g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_KillChick" );
        exit(101);
      }
      #endif
      pc_data->m_chick->OnYouAreDead(); // No data to pass
      break;
    case pcomm_Mating:
      #ifdef __PAR_PCDEBUG
      if (pc_data->m_female->GetMate() != NULL) {
        g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_Mating" );
        exit(102);
      }
      #endif
      pc_data->m_female->OnMating(pc_data);
      break;
    case pcomm_MatingM:
      #ifdef __PAR_PCDEBUG
      if (pc_data->m_male->GetMate() != NULL) {
        g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_MatingM" );
        exit(102);
      }
      #endif
      pc_data->m_male->OnMating(pc_data->m_female);
      break;
    case pcomm_MaleDying:
      #ifdef __PAR_PCDEBUG
      if (pc_data->m_female->GetMate() != pc_data->m_male) {
        g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_MaleDying" );
        exit(103);
      }
      #endif
      pc_data->m_female->OnMateDying(pc_data);
      break;
    case pcomm_EggsHatch:
      #ifdef __PAR_PCDEBUG
        if (pc_data->m_female->GetClutch() != pc_data->m_clutch) {
          g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_EggsHatch1" );
          exit(104);
        }
      if ( pc_data->m_male ) if (pc_data->m_male->GetMate() != pc_data->m_female) {
        g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_EggsHatch2" );
        exit (113);
      }
      if ((pc_data->m_female->GetMate() == NULL)&& ( pc_data->m_male != NULL)) {
        g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_EggsHatch3" );
        exit (113);
      }
      #endif
      // It is possible that there is no male if he was killed under incubation
      if ( pc_data->m_male ) pc_data->m_male->OnLookAfterKids( );
      pc_data->m_female->OnEggsHatch();
      break;
    case pcomm_SetClutch:
      #ifdef __PAR_PCDEBUG
      if (pc_data->m_female->WhatState() != pars_FMakingNest) {
        g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_SetClutch" );
        exit(111);
      }
      #endif
      pc_data->m_female->OnSetMyClutch(pc_data);
      break;
    case pcomm_WaitForMale:
      #ifdef __PAR_PCDEBUG
      if (pc_data->m_female->GetMate() != NULL) {
        g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_WaitForMale" );
        exit(106);
      }
      #endif
      pc_data->m_female->OnWaitForMale();
      break;
    case pcomm_ClutchDead:
      #ifdef __PAR_PCDEBUG
        if (pc_data->m_female->GetClutch() != pc_data->m_clutch) {
          g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_ClutchDead" );
          exit(107);
        }
      #endif
      pc_data->m_female->OnClutchDeath();
      break;
    case pcomm_AllInfertile:
      #ifdef __PAR_PCDEBUG
        if (pc_data->m_female->GetClutch() != pc_data->m_clutch) {
          g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_ClutchDead" );
          exit(107);
        }
      #endif
      pc_data->m_female->OnClutchDeath();
      break;
    case pcomm_ClutchMown:
      #ifdef __PAR_PCDEBUG
        if (pc_data->m_female->GetClutch() != pc_data->m_clutch) {
          g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_ClutchMown" );
          exit(107);
        }
      #endif
      pc_data->m_female->OnClutchMown();
      break;
    case pcomm_MumDeadC:
      // Possible to get here and have an old mate but no mate
      if (pc_data->m_female->GetOldMate() != NULL) {
      #ifdef __PAR_PCDEBUG
          if (pc_data->m_female != pc_data->m_female->GetOldMate()->GetOldMate()) {
            g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_MumDeadC3 - old mate mismatch" );
            exit(117);
        }
      #endif
        pc_data->m_female->GetOldMate()->RemoveOldMate(false);
      }
      // Possible that this is called with no male
      if (pc_data->m_male != NULL) {
      #ifdef __PAR_PCDEBUG
        if (pc_data->m_female->GetMate() != pc_data->m_male) {
          g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_MumDeadC1" );
        exit(108);
        }
      #endif
        pc_data->m_male->OnMateDying();
      }
      // Quite possible this is called with no clutch
      if (pc_data->m_clutch != NULL) {
      #ifdef __PAR_PCDEBUG
      if ((pc_data->m_female->WhatState() != pars_FIncubating) && (pc_data->m_female->WhatState() != pars_FLaying)) {
        g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_MumDeadC2" );
        exit(112);
      }
      #endif
        pc_data->m_clutch->OnMumDead();
      }
      break;
    case pcomm_FemaleGivingUp:
      #ifdef __PAR_PCDEBUG
        if (pc_data->m_female->GetMate() != pc_data->m_male) {
          g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_FemaleGivingUp" );
        exit(109);
        }
      #endif
      pc_data->m_male->OnFemaleGivingUp();
      break;
    case pcomm_ClutchEaten:
      #ifdef __PAR_PCDEBUG
        if (pc_data->m_female->GetClutch() == NULL) {
          g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_ClutchEaten" );
        exit(110);
        }
      #endif
      pc_data->m_clutch->OnEaten();
      break;
    case pcomm_AllChicksDead:
      #ifdef __PAR_PCDEBUG
        if (pc_data->m_female) if (pc_data->m_female->GetMate() != pc_data->m_male) {
          g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_AllChicksDead" );
        exit(111);
        }
      #endif
      // All chicks are dead so tell the sad news to the parents, if they live
      if (pc_data->m_male) pc_data->m_male->OnChicksDead();
      if (pc_data->m_female) {
        pc_data->m_female->OnChicksDead();
      }
      break;
    case pcomm_ChicksMature:
      #ifdef __PAR_PCDEBUG
        if (pc_data->m_female) if (pc_data->m_female->GetMate() != pc_data->m_male) {
          g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_ChickMature" );
        exit(114);
        }
      #endif
      // All chicks are dead so tell the sad news to the parents, if they live
      if (pc_data->m_male) pc_data->m_male->OnChicksMatured();
      if (pc_data->m_female) pc_data->m_female->OnChicksMatured();
      break;
    case pcomm_StoppingBreeding:
      #ifdef __PAR_PCDEBUG
        if (pc_data->m_female->GetMate() != pc_data->m_male) {
          g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_StoppingBreeding" );
        exit(115);
        }
      #endif
      pc_data->m_male->OnStoppingBreeding();
      break;
    case pcomm_MovingHome:
      #ifdef __PAR_PCDEBUG
        if (pc_data->m_female->GetMate() != pc_data->m_male) {
          g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "pcomm_MovingHome" );
        exit(116);
        }
      #endif
      pc_data->m_male->OnMovingHome();
      break;
    default:
    g_msg->Warn( WARN_BUG, "Partridge_Communication::PassMessage():", "No matching message" );
     exit(199);
  }
  #ifdef __PARPCDEBUG
  ClearData(pc_data);
  #endif
  return true;
}

References g_msg, Partridge_Female::GetClutch(), Partridge_Male::GetMate(), Partridge_Female::GetMate(), Partridge_Base::GetObjectType(), Partridge_Male::GetOldMate(), Partridge_Female::GetOldMate(), PartridgeCommunicationData::m_chick, PartridgeCommunicationData::m_clutch, PartridgeCommunicationData::m_female, PartridgeCommunicationData::m_male, Partridge_Male::OnChicksDead(), Partridge_Female::OnChicksDead(), Partridge_Male::OnChicksMatured(), Partridge_Female::OnChicksMatured(), Partridge_Female::OnClutchDeath(), Partridge_Female::OnClutchMown(), Partridge_Clutch::OnEaten(), Partridge_Female::OnEggsHatch(), Partridge_Male::OnFemaleGivingUp(), Partridge_Male::OnLookAfterKids(), Partridge_Male::OnMateDying(), Partridge_Female::OnMateDying(), Partridge_Male::OnMating(), Partridge_Female::OnMating(), Partridge_Male::OnMovingHome(), Partridge_Clutch::OnMumDead(), Partridge_Female::OnSetMyClutch(), Partridge_Male::OnStoppingBreeding(), Partridge_Female::OnWaitForMale(), Partridge_Chick::OnYouAreDead(), pars_FIncubating, pars_FLaying, pars_FMakingNest, pcomm_AllChicksDead, pcomm_AllInfertile, pcomm_ChicksMature, pcomm_ClutchDead, pcomm_ClutchEaten, pcomm_ClutchMown, pcomm_EggsHatch, pcomm_FemaleGivingUp, pcomm_KillChick, pcomm_MaleDying, pcomm_Mating, pcomm_MatingM, pcomm_MovingHome, pcomm_MumDeadC, pcomm_SetClutch, pcomm_StoppingBreeding, pcomm_WaitForMale, pob_Chick, Partridge_Male::RemoveOldMate(), MapErrorMsg::Warn(), WARN_BUG, and TAnimal::WhatState().

Referenced by Partridge_Clutch::AgDying(), Partridge_Clutch::ClDeveloping(), Partridge_Population_Manager::CreateObjects(), Partridge_Population_Manager::DissolveCovey(), Partridge_Female::FDying(), Partridge_Female::FFindingTerritory(), Partridge_Female::FIncubating(), Partridge_Female::FLaying(), Partridge_Female::FMakingNest(), Partridge_Female::FStartingNewBrood(), Partridge_Male::MDying(), Partridge_Male::MFindingMate(), Partridge_Covey::OnChickDeath(), and Partridge_Covey::OnChickMature().

---

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

• C:/Repo/ALMaSS_All/Partridge/Partridge_Communication.h
• C:/Repo/ALMaSS_All/Partridge/Partridge_Communication.cpp