StatRecorder< S > Class Template Reference

Stores the pointers to the StatHandler's stat functions. More...

#include <statrecorder.h>

Inheritance diagram for StatRecorder< S >:

Collaboration diagram for StatRecorder< S >:

Public Member Functions
	StatRecorder ()
void	set (std::string T, std::string N, age_t AGE, unsigned int ARG1, unsigned int ARG2, double(S::*getNoArg)(void), double(S::*getOneArg)(unsigned int), double(S::*getTwoArg)(unsigned int, unsigned int), void(S::*setStat)(void))
	Sets the recorder attributes. More...
void	setHandler (S *theHandler)
	Sets the pointer to the StatHandler that owns this recorder. More...
virtual double	setVal (age_t AGE)
	Calls the linked stat function and returns the result. More...
Public Member Functions inherited from StatRecBase
	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...
void	setName (std::string N)
std::string	getTitle ()
std::string	getName ()
age_t	getAge ()
unsigned int	getArg1 ()
unsigned int	getArg2 ()

Private Attributes
double(S::*	_getStat )(void)
	Pointer to a 'stat getter' function of S using no argument. More...
double(S::*	_getStatOneArg )(unsigned int)
	Pointer to a 'stat getter' function of S using a single unsigned int argument. More...
double(S::*	_getStatTwoArg )(unsigned int, unsigned int)
	Pointer to a 'stat getter' function of S using two unsigned int arguments. More...
void(S::*	_setStat )(void)
	Pointer to a 'stat setter' function of S using no argument. More...
S *	_myHandler
	Pointer to the owner of this recorder. More...

Detailed Description

template<class S>
class StatRecorder< S >

Stores the pointers to the StatHandler's stat functions.

Constructor & Destructor Documentation

StatRecorder()

template<class S >

StatRecorder< S >::StatRecorder ( )

inline

                 : _getStat(0), _getStatOneArg(0), _getStatTwoArg(0),
  _setStat(0), _myHandler(0) {}

Member Function Documentation

set()

template<class S >

void StatRecorder< S >::set	(	std::string	T,
		std::string	N,
		age_t	AGE,
		unsigned int	ARG1,
		unsigned int	ARG2,
		double(S::*)(void)	getNoArg,
		double(S::*)(unsigned int)	getOneArg,
		double(S::*)(unsigned int, unsigned int)	getTwoArg,
		void(S::*)(void)	setStat
	)

Sets the recorder attributes.

Parameters

T	the stat title
N	the stat name (headers in the output file)
AGE	age on which the stat should be processed
ARG1	the frist argument to pass to the S function
ARG2	the second argument to pass to the S function
getNoArg	function ptr to a S getter, taking no arguments
getOneArg	function ptr to a S getter with a single uint argument
getTwoArg	function ptr to a S getter with two uint arguments
setStat	ptr to a setter function in class S

{
  StatRecBase::set(T, N, AGE, ARG1, ARG2);
  
  _getStat = getNoArg;
  _getStatOneArg = getOneArg;
  _getStatTwoArg = getTwoArg;
  _setStat = setStat;
}

References StatRecBase::set().

Referenced by StatHandler< SH >::add().

Here is the caller graph for this function:

setHandler()

template<class S >

void StatRecorder< S >::setHandler ( S *  theHandler )

inline

Sets the pointer to the StatHandler that owns this recorder.

{_myHandler = theHandler;}

References StatRecorder< S >::_myHandler.

Referenced by StatHandler< SH >::add().

Here is the caller graph for this function:

setVal()

template<class S >

double StatRecorder< S >::setVal ( age_t  AGE )

virtual

Calls the linked stat function and returns the result.

Returns

the stat value that will be recorded in the output file

Parameters

AGE	age class on which the stat should be processed

Implements StatRecBase.

{
  double statValue = 0;
 
  if(getAge() & AGE) {
#ifdef _DEBUG_
    message(" %s",getName().c_str());
#endif
    //run _setStat if exists
    if(_setStat != 0)  (_myHandler->*_setStat)();
    
    //get the value:
    if(_getStat != 0)
      
      statValue = (_myHandler->*_getStat)();
    
    else if(_getStatOneArg != 0)
      
      statValue = (_myHandler->*_getStatOneArg)(getArg1());
    
    else if(_getStatTwoArg != 0)
      
      statValue = (_myHandler->*_getStatTwoArg)(getArg1(), getArg2());
    
    else {
 
      fatal("StatRecorder \"%s\" has no _getStat funct ptr !!\n", getName().c_str());
      
    }
  }
  
  return statValue;
}

References fatal(), and message().

Member Data Documentation

_getStat

template<class S >

double(S::* StatRecorder< S >::_getStat) (void)

private

Pointer to a 'stat getter' function of S using no argument.

_getStatOneArg

template<class S >

double(S::* StatRecorder< S >::_getStatOneArg) (unsigned int)

private

Pointer to a 'stat getter' function of S using a single unsigned int argument.

_getStatTwoArg

template<class S >

double(S::* StatRecorder< S >::_getStatTwoArg) (unsigned int, unsigned int)

private

Pointer to a 'stat getter' function of S using two unsigned int arguments.

_myHandler

template<class S >

S* StatRecorder< S >::_myHandler

private

Pointer to the owner of this recorder.

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

_setStat

template<class S >

void(S::* StatRecorder< S >::_setStat) (void)

private

Pointer to a 'stat setter' function of S using no argument.

A setter function only sets some inner variables subsequently fetched by getter's

---

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

• statrecorder.h