StatRecBase Class Reference

Base class for the StatRecorder's, declares the interface to record stat values. More...

#include <statrecorder.h>

Inheritance diagram for StatRecBase:

Collaboration diagram for StatRecBase:

Public Member Functions
	StatRecBase ()
virtual	~StatRecBase ()
void	set (std::string T, std::string N, age_t AGE, unsigned int ARG1, unsigned int ARG2)
	Sets the recorder attributes. More...
virtual double	setVal (age_t AGE)=0
	Stores the value in the vector following the ordering option. More...
Accessors
void	setName (std::string N)
std::string	getTitle ()
std::string	getName ()
age_t	getAge ()
unsigned int	getArg1 ()
unsigned int	getArg2 ()

Private Attributes
std::string	_title
	The title of the stat recorder, longer and more explicite than the name. More...
std::string	_name
	Name of the stat, should be short (20 char) and R compliant (no '-', '+', ' ') More...
unsigned int	_arg1
	A argument to be passed to one of the function variable stored in the StatRecorder structure. More...
unsigned int	_arg2
age_t	_age
	The age class for which this stat applies. More...

Detailed Description

Base class for the StatRecorder's, declares the interface to record stat values.

Constructor & Destructor Documentation

StatRecBase()

StatRecBase::StatRecBase ( )

inline

: _title(""), _name(""), _arg1(0), _arg2(0), _age(ALL) { }

~StatRecBase()

virtual StatRecBase::~StatRecBase ( )

inlinevirtual

{ }

Member Function Documentation

getAge()

age_t StatRecBase::getAge ( )

inline

{return _age;}

References _age.

getArg1()

unsigned int StatRecBase::getArg1 ( )

inline

{return _arg1;}

References _arg1.

getArg2()

unsigned int StatRecBase::getArg2 ( )

inline

{return _arg2;}

References _arg2.

getName()

std::string StatRecBase::getName ( )

inline

{return _name;}

References _name.

getTitle()

std::string StatRecBase::getTitle ( )

inline

{return _title;}

References _title.

set()

void StatRecBase::set ( std::string  T, std::string  N, age_t  AGE, unsigned int  ARG1, unsigned int  ARG2  )

inline

Sets the recorder attributes.

Parameters

T	the stat title (not printed in output)
N	the stat name (headers in the output file)
AGE	the age class for which the stat will be recorded
ARG1	the argument to pass to the S function
ARG2	the argument to pass to the S function

  {
    _title = T;
    _name = N;
    _age = AGE;
    _arg1 = ARG1;
    _arg2 = ARG2;
  }  

References _age, _arg1, _arg2, _name, and _title.

Referenced by StatRecorder< S >::set().

Here is the caller graph for this function:

setName()

void StatRecBase::setName ( std::string  N )

inline

{_name = N;}

References _name.

setVal()

virtual double StatRecBase::setVal ( age_t  AGE )

pure virtual

Stores the value in the vector following the ordering option.

Parameters

AGE	the age-class flag

Implemented in StatRecorder< S >, StatRecorder< LCE_SelectionSH >, StatRecorder< MPStatHandler >, StatRecorder< TTBDMI_SH >, StatRecorder< TTDeletMutBitstrSH >, StatRecorder< TTDispersalSH >, StatRecorder< TTNeutralGenesSH >, StatRecorder< TTQuantiSH >, StatRecorder< TTWolbachiaSH >, and StatRecorder< SH >.

Member Data Documentation

_age

age_t StatRecBase::_age

private

The age class for which this stat applies.

Referenced by getAge(), and set().

_arg1

unsigned int StatRecBase::_arg1

private

A argument to be passed to one of the function variable stored in the StatRecorder structure.

Referenced by getArg1(), and set().

_arg2

unsigned int StatRecBase::_arg2

private

Referenced by getArg2(), and set().

_name

std::string StatRecBase::_name

private

Name of the stat, should be short (20 char) and R compliant (no '-', '+', ' ')

Referenced by getName(), set(), and setName().

_title

std::string StatRecBase::_title

private

The title of the stat recorder, longer and more explicite than the name.

Referenced by getTitle(), and set().

---

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

• statrecorder.h