CoveyManager Class Reference

The covey manager class. More...

#include <Partridge_Covey.h>

Public Member Functions
void	SanityCheck1 ()
	A debug function. More...
void	AddCovey (Partridge_Covey *a_covey)
	Add a new covey. More...
bool	DelCovey (Partridge_Covey *a_covey)
	Remove a covey. More...
int	CoveyDensity (int x, int y, int radius)
	Unused. More...
double	BroodGeoMean ()
	Calculate the geometric mean of no of chicks. More...
void	Setpar_force_ignore_below (double ff)
	Set the minimum interesting force. More...
double	Getpar_force_ignore_below ()
	Get the minimum interesting force. More...
void	Tick (void)
	Do the covey management for the time-step. More...
	CoveyManager (unsigned int a_world_width, unsigned int a_world_height, Landscape *a_map)
	Constructor. More...
	~CoveyManager (void)
	Destructor. More...

Private Attributes
int	m_id_counter
	Counter to keep track of covey ids. More...
int	m_world_width
	Landscape width. More...
int	m_world_height
	Landscape height. More...
int	m_world_width_div2
	Half landscape width. More...
int	m_world_height_div2
	Half landscape height. More...
Landscape *	m_map
	Pointer to the landscape. More...
double	m_par_force_ignore_below
	Minimum interesting force. More...

Detailed Description

The covey manager class.

The covey manaer takes over the role of the Population_Manager for animal models. This is a design fault of historical origin and should be rectified one day with the Partridge_Population_Manager taking over this role.

Definition at line 792 of file Partridge_Covey.h.

Constructor & Destructor Documentation

CoveyManager()

CoveyManager::CoveyManager	(	unsigned int	a_world_width,
		unsigned int	a_world_height,
		Landscape *	a_map
	)

Constructor.

Definition at line 2072 of file Partridge_Covey.cpp.

                                                                                                       {
  m_world_width = a_world_width;
  m_world_height = a_world_height;
  m_world_width_div2 = m_world_width / 2;
  m_world_height_div2 = m_world_width / 2;
  m_map = a_map;
 
  g_trig_sin = new double[ TRIG_TABLE_LENGTH ];
  g_trig_cos = new double[ TRIG_TABLE_LENGTH ];
 
  Setpar_force_ignore_below( cfg_par_force_ignore_below.value() );
 
 
  if ( !g_trig_sin || !g_trig_cos ) {
    g_msg->Warn( WARN_MSG, "CoveyManager::CoveyManager(): Out of memory.", "" );
    exit( 1 );
  }
 
  double l_val = 0.0;
  double l_step = TWO_PI / TRIG_TABLE_LENGTH;
  for ( int i = 0; i < TRIG_TABLE_LENGTH; i++ ) {
    g_trig_sin[ i ] = sin( l_val );
    g_trig_cos[ i ] = cos( l_val );
    l_val += l_step;
  }
}

References cfg_par_force_ignore_below, g_msg, g_trig_cos, g_trig_sin, m_map, m_world_height, m_world_height_div2, m_world_width, m_world_width_div2, Setpar_force_ignore_below(), TRIG_TABLE_LENGTH, CfgFloat::value(), MapErrorMsg::Warn(), and WARN_MSG.

~CoveyManager()

CoveyManager::~CoveyManager

(

void

)

Destructor.

Definition at line 2099 of file Partridge_Covey.cpp.

                                  {
  delete g_trig_sin;
  delete g_trig_cos;
}

References g_trig_cos, and g_trig_sin.

Member Function Documentation

AddCovey()

void CoveyManager::AddCovey

(

Partridge_Covey *

a_covey

)

Add a new covey.

Definition at line 2222 of file Partridge_Covey.cpp.

                                                       {
  unsigned int l_newindex = (int)g_covey_list.size();
  g_covey_list.resize( l_newindex + 1 );
  g_covey_list[ l_newindex ] = a_covey;
}

References g_covey_list.

Referenced by Partridge_Covey::Partridge_Covey().

BroodGeoMean()

double CoveyManager::BroodGeoMean

(

void

)

Calculate the geometric mean of no of chicks.

Definition at line 2117 of file Partridge_Covey.cpp.

                                        {
  double product = 0;
  int NoBr = 0;
  int sz = (int)g_covey_list.size();
  if ( sz < 2000 ) {
    for ( int i = 0; i < sz; i++ ) {
      double chs = ( double )g_covey_list[ i ]->GetOurChicks();
      // only count those with chicks
      if ( chs > 0 ) {
        product += log10( chs );
        NoBr++;
      }
    }
    if ( NoBr > 0 ) {
      double power = 1.0 / NoBr;
      product *= power; // Mulitply log by the power
      // Antilog it
      double result = pow( 10, product );
      return result;
    }
  }
  return 0.0;
}

References g_covey_list.

Referenced by Partridge_Population_Manager::DoFirst().

CoveyDensity()

int CoveyManager::CoveyDensity	(	int	x,
		int	y,
		int	radius
	)

Unused.

Search through the list of coveys and find out how many are within radius of x,y.

Definition at line 2178 of file Partridge_Covey.cpp.

                                                         {
  int tx, ty;
  int No = 0;
  int x1 = x - radius;
  int x2 = x + radius;
  int y1 = y - radius;
  int y2 = y + radius;
  // As usual this is complicated by the fact that x,y, might overlap boundries
  //
  if ( ( x - radius < 0 ) || ( x + radius >= m_world_width ) || ( y - radius < 0 ) || ( y + radius >= m_world_height ) ) {
    // Danger of running into the edge of the world
    // Also for speed and ease of calculation our radius is that of a square
    //
    for ( int i = 0; i < (int) g_covey_list.size(); i++ ) {
      tx = g_covey_list[ i ]->X();
      ty = g_covey_list[ i ]->Y();
      int dx = abs( x - tx );
      int dy = abs( y - ty );
      if ( dx > m_world_width_div2 ) dx = m_world_width - dx;
      if ( dy > m_world_height_div2 ) dy = m_world_height - dy;
      if ( ( tx < x2 ) && ( tx >= x1 ) && ( ty >= y1 ) && ( ty < y2 ) ) {
        // We have found one
        No++;
      }
    }
  } else {
    // Simple case, not near to the edge
    // Also for speed and ease of calculation our radius is that of a square
    //
    for ( int i = 0; i < (int) (g_covey_list.size()); i++ ) {
      tx = g_covey_list[ i ]->X();
      ty = g_covey_list[ i ]->Y();
      if ( ( tx <= x2 ) && ( tx >= x1 ) && ( ty >= y1 ) && ( ty <= y2 ) ) {
        // We have found one
        No++;
      }
    }
  }
  return No;
}

References g_covey_list, m_world_height, m_world_height_div2, m_world_width, and m_world_width_div2.

DelCovey()

bool CoveyManager::DelCovey

(

Partridge_Covey *

a_covey

)

Remove a covey.

Definition at line 2230 of file Partridge_Covey.cpp.

                                                       {
  unsigned int l_id = a_covey->ID();
 
  if ( a_covey->ManagerIsPermanant() ) {
    // Raise hell. Someone thought a permanent landscape marker
    // belonged to them.
    assert( false );
  }
 
  for ( unsigned int i = 0; i < g_covey_list.size(); i++ ) {
    if ( l_id == g_covey_list[ i ]->ID() ) {
      // Throw away our local pointer to the covey by
      // moving the rest of the elements down in the list.
      for ( unsigned int j = i + 1; j < g_covey_list.size(); j++ ) {
        g_covey_list[ j - 1 ] = g_covey_list[ j ];
      }
      g_covey_list.resize( g_covey_list.size() - 1 );
      return true;
    }
  }
 
  // Didn't find requested ID.
  return false;
}

References g_covey_list, Partridge_Covey::ID(), and Partridge_Covey::ManagerIsPermanant().

Referenced by Partridge_Covey::RemoveMember(), and Partridge_Covey::~Partridge_Covey().

Getpar_force_ignore_below()

double CoveyManager::Getpar_force_ignore_below ( )

inline

Get the minimum interesting force.

Definition at line 822 of file Partridge_Covey.h.

                                       {
        return m_par_force_ignore_below;
    }

References m_par_force_ignore_below.

Referenced by Partridge_Covey::ManagerRethinkPos().

SanityCheck1()

void CoveyManager::SanityCheck1

(

void

)

A debug function.

Definition at line 2104 of file Partridge_Covey.cpp.

                                      {
  for ( PointerInt i = 0; i < (unsigned) g_covey_list.size(); i++ ) {
    if ( ( PointerInt )g_covey_list[ i ] < 1000 ) {
      g_msg->Warn( WARN_MSG, "CoveyManager::SanityCheck1(): NOT Sane", "" );
      exit( 0 );
    }
  }
}

References g_covey_list, g_msg, MapErrorMsg::Warn(), and WARN_MSG.

Setpar_force_ignore_below()

void CoveyManager::Setpar_force_ignore_below

(

double

ff

)

Set the minimum interesting force.

Definition at line 2113 of file Partridge_Covey.cpp.

                                                        {
  m_par_force_ignore_below = ff;
}

References m_par_force_ignore_below.

Referenced by CoveyManager().

Tick()

void CoveyManager::Tick

(

void

)

Do the covey management for the time-step.

Moves all covey pegs as necessary and checks for merging

Definition at line 2144 of file Partridge_Covey.cpp.

                              {
  // Copies m_center_*_float into m_new_center_*_float.
  for ( unsigned int i = 0; i < g_covey_list.size(); i++ ) {
    g_covey_list[ i ]->ManagerRethinkPos();
  }
 
  // Adds any deltas to m_new_center_*_float.
  for ( unsigned int i = 0; i < g_covey_list.size(); i++ ) {
    g_covey_list[ i ]->ManagerDriftPos();
  }
 
  // Copies the m_new_center_*_float position back
  // into m_center_*_float, updating covey positions.
  for ( unsigned int i = 0; i < g_covey_list.size(); i++ ) {
    g_covey_list[ i ]->ManagerUpdatePos();
  }
 
  // This code removed to stop merging 011004 CJT (why?)
  // Only test for merging between certain dates
  //
  if ( ( m_map->SupplyDayInYear() >= cfg_par_firstmerge.value() )
       || ( m_map->SupplyDayInYear() <= cfg_par_lastmerge.value() ) ) {
         for ( unsigned int i = 0; i < g_covey_list.size(); i++ ) {
           if ( g_covey_list[ i ]->AllFlocking() ) {
             // Only singles and barren pairs are allowed to initiate merging
             if ( g_covey_list[ i ]->GetCoveySize() < 3 ) g_covey_list[ i ]->ManagerCheckMerge();
           }
         }
  }
//*/
}

References cfg_par_firstmerge, cfg_par_lastmerge, g_covey_list, m_map, Landscape::SupplyDayInYear(), and CfgInt::value().

Referenced by Partridge_Population_Manager::DoFirst().

Member Data Documentation

m_id_counter

int CoveyManager::m_id_counter

private

Counter to keep track of covey ids.

Definition at line 794 of file Partridge_Covey.h.

m_map

Landscape* CoveyManager::m_map

private

Pointer to the landscape.

Definition at line 804 of file Partridge_Covey.h.

Referenced by CoveyManager(), and Tick().

m_par_force_ignore_below

double CoveyManager::m_par_force_ignore_below

private

Minimum interesting force.

Definition at line 806 of file Partridge_Covey.h.

Referenced by Getpar_force_ignore_below(), and Setpar_force_ignore_below().

m_world_height

int CoveyManager::m_world_height

private

Landscape height.

Definition at line 798 of file Partridge_Covey.h.

Referenced by CoveyDensity(), and CoveyManager().

m_world_height_div2

int CoveyManager::m_world_height_div2

private

Half landscape height.

Definition at line 802 of file Partridge_Covey.h.

Referenced by CoveyDensity(), and CoveyManager().

m_world_width

int CoveyManager::m_world_width

private

Landscape width.

Definition at line 796 of file Partridge_Covey.h.

Referenced by CoveyDensity(), and CoveyManager().

m_world_width_div2

int CoveyManager::m_world_width_div2

private

Half landscape width.

Definition at line 800 of file Partridge_Covey.h.

Referenced by CoveyDensity(), and CoveyManager().

---

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

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