probe_data Class Reference

Data structure to hold & output probe data probe data is designed to be used to return the number of objects in a given area or areas in specific element or vegetation types or farms. More...

#include <PopulationManager.h>

Public Member Functions
void	CloseFile ()
void	FileAppendOutput (int No, int time)
void	FileOutput (int No, int time, int ProbeNo)
ofstream *	OpenFile (char *Nme)
bool	OpenForAppendToFile ()
	probe_data ()
void	SetFile (ofstream *F)
	~probe_data ()

Public Attributes
bool	m_FileRecord
unsigned	m_NoAreas
unsigned	m_NoEleTypes
unsigned	m_NoFarms
unsigned	m_NoVegTypes
rectangle	m_Rect [10]
TTypesOfLandscapeElement	m_RefEle [25]
unsigned	m_RefFarms [25]
TTypesOfVegetation	m_RefVeg [25]
unsigned	m_ReportInterval
bool	m_TargetTypes [10]

Protected Attributes
ofstream *	m_MyFile
char	m_MyFileName [255]
int	m_Time

Detailed Description

Data structure to hold & output probe data probe data is designed to be used to return the number of objects in a given area or areas in specific element or vegetation types or farms.

Constructor & Destructor Documentation

probe_data::probe_data

(

)

Constructor for probe_data

                       {
  m_Time = 0;
  m_FileRecord = false;
  m_MyFile = NULL;
}

probe_data::~probe_data

(

)

Destructor for probe_data

                        {
}

Member Function Documentation

void probe_data::CloseFile

(

)

Referenced by CloseDownSim().

                           {
  if ( m_MyFile != NULL ) {
          if (m_MyFile->is_open()) m_MyFile->close();
          delete m_MyFile;
  }
};

void probe_data::FileAppendOutput	(	int	No,
		int	time
	)

                                                    {
  m_MyFile->open(m_MyFileName,ios::app);
  if ( !m_MyFile->is_open() ) {
    g_msg->Warn( (MapErrorState)0,"Cannot open file for append: ", m_MyFileName );
    exit( 0 );
  }
  if ( m_FileRecord ) {
   (*m_MyFile)<< time << '\t' << No << endl;
  }
  m_MyFile->close();
}

void probe_data::FileOutput	(	int	No,
		int	time,
		int	ProbeNo
	)

Basic output function of the default probe data file.
This just counts numbers in specified areas

                                                           {
  if ( m_FileRecord ) {

    if ( ProbeNo == 0 ) {
      // First probe so write the time and a new line
      (*m_MyFile) << endl;
      (*m_MyFile) << time << '\t' << No;
    } else
      (*m_MyFile) << '\t' << No ;
  }
  (*m_MyFile).flush();
}

ofstream * probe_data::OpenFile

(

char *

Nme

)

Opens the default probe data output file

Referenced by GetProbeInput_ini().

                                            {
  m_MyFile = new ofstream( Nme );
  if ( !m_MyFile->is_open() ) {
    g_msg->Warn( (MapErrorState)0,"probe_data::OpenFile - Cannot open file: ", Nme );
    exit( 0 );
  }
  strcpy( m_MyFileName, Nme );
  return m_MyFile;
}

bool probe_data::OpenForAppendToFile ( )

inline

                             {
          m_MyFile = new ofstream(m_MyFileName, ios::app);
          if (!(*m_MyFile).is_open())
          {
                  g_msg->Warn( WARN_FILE, "PopulationManager::AppendToFile() Unable to open file for append: ", m_MyFileName );
                  exit(1);
          }
          return true;
  }

void probe_data::SetFile

(

ofstream *

F

)

Sets the filename for the default probe data output

Referenced by GetProbeInput_ini().

                                       {
  m_MyFile = F;
}

Member Data Documentation

bool probe_data::m_FileRecord

ofstream* probe_data::m_MyFile

protected

char probe_data::m_MyFileName[255]

protected

unsigned probe_data::m_NoAreas

Referenced by Population_Manager::Probe().

unsigned probe_data::m_NoEleTypes

Referenced by Population_Manager::Probe().

unsigned probe_data::m_NoFarms

Referenced by Population_Manager::Probe().

unsigned probe_data::m_NoVegTypes

Referenced by Population_Manager::Probe().

rectangle probe_data::m_Rect[10]

Referenced by Population_Manager::Probe().

TTypesOfLandscapeElement probe_data::m_RefEle[25]

Referenced by Population_Manager::Probe().

unsigned probe_data::m_RefFarms[25]

Referenced by Population_Manager::Probe().

TTypesOfVegetation probe_data::m_RefVeg[25]

Referenced by Population_Manager::Probe().

unsigned probe_data::m_ReportInterval

bool probe_data::m_TargetTypes[10]

int probe_data::m_Time

protected

---

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

• PopulationManager.h
• PopulationManager.cpp