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)
void	FileAppendOutput (int No, int time)
	probe_data ()
void	SetFile (ofstream *F)
ofstream *	OpenFile (char *Nme)
bool	OpenForAppendToFile ()
void	CloseFile ()
	~probe_data ()

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

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.

Definition at line 283 of file populationmanager.h.

Constructor & Destructor Documentation

probe_data()

probe_data::probe_data

(

)

Constructor for probe_data

Definition at line 1479 of file PopulationManager.cpp.

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

~probe_data()

probe_data::~probe_data

(

)

Destructor for probe_data

Definition at line 1513 of file PopulationManager.cpp.

                        {
}

Member Function Documentation

CloseFile()

void probe_data::CloseFile

(

)

Definition at line 135 of file PopulationManager.cpp.

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

FileAppendOutput()

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

Definition at line 1462 of file PopulationManager.cpp.

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

References g_msg, and MapErrorMsg::Warn().

FileOutput()

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

Definition at line 1447 of file PopulationManager.cpp.

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

OpenFile()

ofstream * probe_data::OpenFile

(

char *

Nme

)

Opens the default probe data output file

Definition at line 1490 of file PopulationManager.cpp.

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

References g_msg, and MapErrorMsg::Warn().

OpenForAppendToFile()

bool probe_data::OpenForAppendToFile ( )

inline

Definition at line 308 of file populationmanager.h.

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

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

SetFile()

void probe_data::SetFile

(

ofstream *

F

)

Sets the filename for the default probe data output

Definition at line 1504 of file PopulationManager.cpp.

                                       {
  m_MyFile = F;
}

Member Data Documentation

m_FileRecord

bool probe_data::m_FileRecord

Definition at line 290 of file populationmanager.h.

m_MyFile

ofstream* probe_data::m_MyFile

protected

Definition at line 286 of file populationmanager.h.

Referenced by OpenForAppendToFile().

m_MyFileName

char probe_data::m_MyFileName[255]

protected

Definition at line 288 of file populationmanager.h.

Referenced by OpenForAppendToFile().

m_NoAreas

unsigned probe_data::m_NoAreas

Definition at line 292 of file populationmanager.h.

Referenced by Population_Manager::Probe().

m_NoEleTypes

unsigned probe_data::m_NoEleTypes

Definition at line 294 of file populationmanager.h.

Referenced by Population_Manager::Probe().

m_NoFarms

unsigned probe_data::m_NoFarms

Definition at line 296 of file populationmanager.h.

Referenced by Population_Manager::Probe().

m_NoVegTypes

unsigned probe_data::m_NoVegTypes

Definition at line 295 of file populationmanager.h.

Referenced by Population_Manager::Probe().

m_Rect

rectangle probe_data::m_Rect[10]

Definition at line 293 of file populationmanager.h.

Referenced by Population_Manager::Probe().

m_RefEle

TTypesOfLandscapeElement probe_data::m_RefEle[25]

Definition at line 298 of file populationmanager.h.

Referenced by Population_Manager::Probe().

m_RefFarms

unsigned probe_data::m_RefFarms[25]

Definition at line 299 of file populationmanager.h.

Referenced by Population_Manager::Probe().

m_RefVeg

TTypesOfVegetation probe_data::m_RefVeg[25]

Definition at line 297 of file populationmanager.h.

Referenced by Population_Manager::Probe().

m_ReportInterval

unsigned probe_data::m_ReportInterval

Definition at line 291 of file populationmanager.h.

m_TargetTypes

bool probe_data::m_TargetTypes[10]

Definition at line 301 of file populationmanager.h.

m_Time

int probe_data::m_Time

protected

Definition at line 287 of file populationmanager.h.

---

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

• C:/Repo/ALMaSS_all/BatchALMaSS/populationmanager.h
• C:/Repo/ALMaSS_all/BatchALMaSS/PopulationManager.cpp