Nemo  2.3.46
StatRecBase Class Referenceabstract

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 ( )
inline
53 : _title(""), _name(""), _arg1(0), _arg2(0), _age(ALL) { }
std::string _title
The title of the stat recorder, longer and more explicite than the name.
Definition: statrecorder.h:42
std::string _name
Name of the stat, should be short (20 char) and R compliant (no '-', '+', ' ')
Definition: statrecorder.h:44
unsigned int _arg1
A argument to be passed to one of the function variable stored in the StatRecorder structure...
Definition: statrecorder.h:46
#define ALL
All ages age class flag.
Definition: types.h:56
age_t _age
The age class for which this stat applies.
Definition: statrecorder.h:49
unsigned int _arg2
Definition: statrecorder.h:47
virtual StatRecBase::~StatRecBase ( )
inlinevirtual
56 { }

Member Function Documentation

age_t StatRecBase::getAge ( )
inline

References _age.

80 {return _age;}
age_t _age
The age class for which this stat applies.
Definition: statrecorder.h:49
unsigned int StatRecBase::getArg1 ( )
inline

References _arg1.

81 {return _arg1;}
unsigned int _arg1
A argument to be passed to one of the function variable stored in the StatRecorder structure...
Definition: statrecorder.h:46
unsigned int StatRecBase::getArg2 ( )
inline

References _arg2.

82 {return _arg2;}
unsigned int _arg2
Definition: statrecorder.h:47
std::string StatRecBase::getName ( )
inline

References _name.

79 {return _name;}
std::string _name
Name of the stat, should be short (20 char) and R compliant (no '-', '+', ' ')
Definition: statrecorder.h:44
std::string StatRecBase::getTitle ( )
inline

References _title.

78 {return _title;}
std::string _title
The title of the stat recorder, longer and more explicite than the name.
Definition: statrecorder.h:42
void StatRecBase::set ( std::string  T,
std::string  N,
age_t  AGE,
unsigned int  ARG1,
unsigned int  ARG2 
)
inline

Sets the recorder attributes.

Parameters
Tthe stat title (not printed in output)
Nthe stat name (headers in the output file)
AGEthe age class for which the stat will be recorded
ARG1the argument to pass to the S function
ARG2the argument to pass to the S function

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

67  {
68  _title = T;
69  _name = N;
70  _age = AGE;
71  _arg1 = ARG1;
72  _arg2 = ARG2;
73  }
std::string _title
The title of the stat recorder, longer and more explicite than the name.
Definition: statrecorder.h:42
std::string _name
Name of the stat, should be short (20 char) and R compliant (no '-', '+', ' ')
Definition: statrecorder.h:44
unsigned int _arg1
A argument to be passed to one of the function variable stored in the StatRecorder structure...
Definition: statrecorder.h:46
age_t _age
The age class for which this stat applies.
Definition: statrecorder.h:49
unsigned int _arg2
Definition: statrecorder.h:47
void StatRecBase::setName ( std::string  N)
inline
77 {_name = N;}
std::string _name
Name of the stat, should be short (20 char) and R compliant (no '-', '+', ' ')
Definition: statrecorder.h:44
virtual double StatRecBase::setVal ( age_t  AGE)
pure virtual

Stores the value in the vector following the ordering option.

Parameters
AGEthe age-class flag

Implemented in StatRecorder< S >.

Member Data Documentation

age_t StatRecBase::_age
private

The age class for which this stat applies.

Referenced by getAge().

unsigned int StatRecBase::_arg1
private

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

Referenced by getArg1().

unsigned int StatRecBase::_arg2
private

Referenced by getArg2().

std::string StatRecBase::_name
private

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

Referenced by getName().

std::string StatRecBase::_title
private

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

Referenced by getTitle().


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

Generated for Nemo v2.3.0 by  doxygen 1.8.8 --
Catalogued on GSR