Iterator class for wrap around landscape
More...

#include <Partridge_Covey.h>

Public Member Functions
int *	GetList (void)
	Get pointer to list of points More...

int	GetLimit (void)
	Get how many points More...

	ForIterator (int a_min_incl, int a_max_excl, int a_step_size, int a_norm_min_incl, int a_norm_max_excl)
	Constructor More...

	~ForIterator (void)
	Destructor More...

Private Attributes
int *	m_list
	List of points More...

int	m_limit
	How many points More...

Detailed Description

Iterator class for wrap around landscape

Definition at line 48 of file Partridge_Covey.h.

Constructor & Destructor Documentation

◆ ForIterator()

ForIterator::ForIterator	(	int	a_min_incl,
		int	a_max_excl,
		int	a_step_size,
		int	a_norm_min_incl,
		int	a_norm_max_excl
	)

Constructor

Definition at line 2256 of file Partridge_Covey.cpp.

                                                                                                                     {
     // a_min_incl or a_max_excl are goint to be <0 or > a_norm_max_excl
     if ( a_step_size > 1 )
         m_limit = ( a_max_excl - a_min_incl ) / a_step_size;
     else
         m_limit = a_max_excl - a_min_incl;
     m_list = new int[ m_limit ];
     if ( !m_list ) assert( false );
  
     int i, index = 0;
     // this only use if a_min_incl < a_norm_min_incl (0)
     for ( i = a_min_incl; i < a_norm_min_incl && index < m_limit; i += a_step_size ) {
         m_list[ index++ ] = i + a_norm_max_excl;
     }
     // a_norm_max_excl is typically the landscape width
     // a_norm_min_incl is typically 0
  
     // This loops is for the normal co-ords
     for ( ; i < a_norm_max_excl && index < m_limit; i += a_step_size ) {
         m_list[ index++ ] = i;
     }
     // if we have exceeded the upper bound then this is used
     for ( ; i < a_max_excl && index < m_limit; i += a_step_size ) {
         m_list[ index++ ] = i - a_norm_max_excl;
     }
 }

References m_limit, and m_list.

◆ ~ForIterator()

ForIterator::~ForIterator ( void )

Destructor

Definition at line 2284 of file Partridge_Covey.cpp.

                                 {
   delete m_list;
 }

References m_list.

Member Function Documentation

◆ GetLimit()

int ForIterator::GetLimit ( void )

inline

Get how many points

Definition at line 61 of file Partridge_Covey.h.

                        {
     return m_limit;
   }

References m_limit.

Referenced by Partridge_Covey::HabitatEvaluateSlow(), and Partridge_Covey::NestFindSlow().

◆ GetList()

int* ForIterator::GetList ( void )

inline

Get pointer to list of points

Definition at line 56 of file Partridge_Covey.h.

                         {
     return m_list;
   }

References m_list.

Referenced by Partridge_Covey::HabitatEvaluateSlow(), and Partridge_Covey::NestFindSlow().

Member Data Documentation

◆ m_limit

int ForIterator::m_limit

private

How many points

Definition at line 52 of file Partridge_Covey.h.

Referenced by ForIterator(), and GetLimit().

◆ m_list

int* ForIterator::m_list

private

List of points

Definition at line 50 of file Partridge_Covey.h.

Referenced by ForIterator(), GetList(), and ~ForIterator().

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

Public Member Functions

Private Attributes