VoleSummaryOutput Class Reference

A base class for summary outputs. More...

#include <VolePopulationManager.h>

Public Member Functions
	VoleSummaryOutput (const char *a_filename, Landscape *a_land, int a_numdataINT, int a_numdataDOUBLE)
virtual	~VoleSummaryOutput ()
virtual void	OPrint ()
virtual void	OPrint (int a_value)
virtual void	OPrint (double a_value)
virtual void	OPrint (const char *a_value)
virtual void	OPrintEndl ()
void	ResetData ()
void	ChangeData (int a_data, int a_value)
void	ChangeData (int a_data, double a_value)

Protected Member Functions
void	OpenOutput (const char *a_filename)
void	CloseOutput () const

Protected Attributes
ofstream *	m_File
Landscape *	m_landscape
int	m_ndInt
int	m_ndDouble
int	m_dataI [100]
double	m_dataD [100]

Detailed Description

A base class for summary outputs.

Constructor & Destructor Documentation

VoleSummaryOutput()

VoleSummaryOutput::VoleSummaryOutput	(	const char *	a_filename,
		Landscape *	a_land,
		int	a_numdataINT,
		int	a_numdataDOUBLE
	)

                                                                {
    m_landscape = a_land;
    OpenOutput(a_filename);
    m_ndInt = a_numdataINT;
    m_ndDouble = a_numdataDOUBLE;
    ResetData();
}

References m_landscape, m_ndDouble, m_ndInt, OpenOutput(), and ResetData().

~VoleSummaryOutput()

VoleSummaryOutput::~VoleSummaryOutput ( )

virtual

{ CloseOutput(); }

References CloseOutput().

Member Function Documentation

ChangeData() [1/2]

void VoleSummaryOutput::ChangeData	(	int	a_data,
		double	a_value
	)

{ m_dataD[a_data] += a_value; }

References m_dataD.

ChangeData() [2/2]

void VoleSummaryOutput::ChangeData	(	int	a_data,
		int	a_value
	)

{ m_dataI[a_data] += a_value; }

References m_dataI.

Referenced by Vole_JuvenileMale::BeginStep(), Vole_JuvenileFemale::BeginStep(), Vole_JuvenileMale::Dispersal(), Vole_Male::Dispersal(), Vole_JuvenileFemale::Dispersal(), Vole_Male::EndStep(), Vole_JuvenileFemale::EndStep(), Vole_JuvenileMale::OnFarmEvent(), Vole_JuvenileFemale::OnFarmEvent(), Vole_JuvenileMale::OnKilled(), Vole_JuvenileFemale::OnKilled(), Vole_JuvenileFemale::Step(), and Vole_Female::Step().

CloseOutput()

void VoleSummaryOutput::CloseOutput ( ) const

protected

                                          {
    m_File->close();
    delete m_File;
}

References m_File.

Referenced by ~VoleSummaryOutput().

OpenOutput()

void VoleSummaryOutput::OpenOutput ( const char *  a_filename )

protected

{ m_File = new ofstream(a_filename, ios::out); }

References m_File.

Referenced by VoleSummaryOutput().

OPrint() [1/4]

void VoleSummaryOutput::OPrint ( )

virtual

                               {
    *m_File << m_landscape->SupplyYearNumber() << '\t' << m_landscape->SupplyDayInYear();
    for (int i = 0; i < m_ndInt; i++) *m_File << '\t' << m_dataI[i];
    for (int i = 0; i < m_ndDouble; i++) *m_File << '\t' << m_dataD[i];
    *m_File << endl;
}

References m_dataD, m_dataI, m_File, m_landscape, m_ndDouble, m_ndInt, Landscape::SupplyDayInYear(), and Landscape::SupplyYearNumber().

Referenced by Vole_Population_Manager::DoFirst(), Vole_Population_Manager::Init(), and Vole_Population_Manager::~Vole_Population_Manager().

OPrint() [2/4]

void VoleSummaryOutput::OPrint ( const char *  a_value )

virtual

{ *m_File << a_value << '\t'; }

References m_File.

OPrint() [3/4]

void VoleSummaryOutput::OPrint ( double  a_value )

virtual

{ *m_File << a_value << '\t'; }

References m_File.

OPrint() [4/4]

void VoleSummaryOutput::OPrint ( int  a_value )

virtual

{ *m_File << a_value << '\t'; }

References m_File.

OPrintEndl()

void VoleSummaryOutput::OPrintEndl ( )

virtual

{ *m_File << endl; }

References m_File.

Referenced by Vole_Population_Manager::Init().

ResetData()

void VoleSummaryOutput::ResetData

(

)

                                  {
    for (int i = 0; i < m_ndInt; i++) m_dataI[i] = 0;
    for (int i = 0; i < m_ndDouble; i++) m_dataD[i] = 0.0;
}

References m_dataD, m_dataI, m_ndDouble, and m_ndInt.

Referenced by Vole_Population_Manager::DoFirst(), and VoleSummaryOutput().

Member Data Documentation

m_dataD

double VoleSummaryOutput::m_dataD[100]

protected

Referenced by ChangeData(), OPrint(), and ResetData().

m_dataI

int VoleSummaryOutput::m_dataI[100]

protected

Referenced by ChangeData(), OPrint(), and ResetData().

m_File

ofstream* VoleSummaryOutput::m_File

protected

Referenced by CloseOutput(), OpenOutput(), OPrint(), and OPrintEndl().

m_landscape

Landscape* VoleSummaryOutput::m_landscape

protected

Referenced by OPrint(), and VoleSummaryOutput().

m_ndDouble

int VoleSummaryOutput::m_ndDouble

protected

Referenced by OPrint(), ResetData(), and VoleSummaryOutput().

m_ndInt

int VoleSummaryOutput::m_ndInt

protected

Referenced by OPrint(), ResetData(), and VoleSummaryOutput().

---

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

• /builds/ALMaSS/ALMaSS_MIDox/Vole/VolePopulationManager.h
• /builds/ALMaSS/ALMaSS_MIDox/Vole/VolePopulationManager.cpp