ALMaSS: 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	FileOutput (int No, int time, int ProbeNo) const

void	FileAppendOutput (int No, int time) const

	Probe_Data ()

void	SetFile (ofstream *F)

ofstream *	OpenFile (const string &Nme)

bool	OpenForAppendToFile ()

void	CloseFile () const

	~Probe_Data ()=default

Public Attributes
bool	m_FileRecord

bool	m_FullLandscapeProbe

unsigned	m_ReportInterval

unsigned	m_NoAreas

rectangle	m_Rect [16]

unsigned	m_NoEleTypes

unsigned	m_NoVegTypes

unsigned	m_NoFarms

TTypesOfVegetation	m_RefVeg [25]

TTypesOfLandscapeElement	m_RefEle [25]

unsigned	m_RefFarms [25]

bool	m_TargetTypes [16]

Protected Attributes
ofstream *	m_MyFile

int	m_Time

char	m_MyFileName [255]

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::Probe_Data ( )

Constructor for probe_data

                       : m_MyFile(nullptr), m_Time(0), m_MyFileName{}, m_FileRecord(false),
                           m_FullLandscapeProbe(false), m_ReportInterval(0), m_NoAreas(0), m_Rect{}, m_NoEleTypes(0),
                           m_NoVegTypes(0), m_NoFarms(0), m_RefVeg{}, m_RefEle{}, m_RefFarms{}, m_TargetTypes{} {
 }

◆ ~Probe_Data()

Probe_Data::~Probe_Data ( )

default

Member Function Documentation

◆ CloseFile()

void Probe_Data::CloseFile ( ) const

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

◆ FileAppendOutput()

void Probe_Data::FileAppendOutput	(	int	No,
		int	time
	)		const

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

References g_msg, m_FileRecord, m_MyFile, m_MyFileName, and MapErrorMsg::Warn().

◆ FileOutput()

void Probe_Data::FileOutput	(	int	No,
		int	time,
		int	ProbeNo
	)		const

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();
 }

References m_FileRecord, and m_MyFile.

Referenced by Population_Manager::ProbeReport(), Skylark_Population_Manager::ProbeReportPOM(), and Population_Manager::ProbeReportTimed().

◆ OpenFile()

ofstream * Probe_Data::OpenFile ( const string & a_Nme )

Opens the default probe data output file

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

References g_msg, m_MyFile, and MapErrorMsg::Warn().

Referenced by GetProbeInput_ini().

◆ OpenForAppendToFile()

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;
     }