OMK::Fifo< T > Class Template Reference

a Fifo to store attribute history thread safety : provided no reader tries to acces values with an offset greater than the numbre of values returned by getNumberOfPresentValues, multiple reads can take place concurrently with one write. More...

#include <OMKFifo.h>

Inheritance diagram for OMK::Fifo< T >:

[legend]Collaboration diagram for OMK::Fifo< T >:

[legend]List of all members.

Public Member Functions
	Fifo (const int taille)
	constructor
virtual	~Fifo ()
	destructor
virtual const T &	getPreceedingValue (const unsigned int indice) const
	get a value before the current value
virtual const Date &	getPreceedingDate (const unsigned int indice) const
	get the date associated to a value before the current value
virtual void	set (const T &val, const Date &date)
	add a value to the fifo
virtual void	setInPlace (const T &val, const Date &date)
	make an allready copied value available for reading
virtual T &	getNextPlaceHolder ()
	get a reference to the next place that will be used to store a value
virtual void	clear ()
	clear the file
virtual unsigned int	getNumberOfPresentValues (int maxCherche=-1) const
	get the number of values in the fifo
virtual void	printDebuggingInformation (void) const
	printDebuggingInformation print any usefull debugging information
Protected Attributes
std::vector< ValeurDate >	_tab
	the array in wich the values are kept
unsigned int	_numberOfValues
	the number of valid values in _tab
unsigned int	_mostRecentValueIndex
	the place the most recent value was stored
Classes
class	ValeurDate
	internal class More...

---

Detailed Description

template<typename T>
class OMK::Fifo< T >

a Fifo to store attribute history thread safety : provided no reader tries to acces values with an offset greater than the numbre of values returned by getNumberOfPresentValues, multiple reads can take place concurrently with one write.

Definition at line 34 of file OMKFifo.h.

---

Constructor & Destructor Documentation

template<typename T>

OMK::Fifo< T >::Fifo

(

const int

taille

)

constructor

Definition at line 109 of file OMKFifo.h.

: AbstractFifo< T >( size ),
_tab( size ),
_numberOfValues( 0 ),
_mostRecentValueIndex( size - 1 )
{
}

template<typename T>

OMK::Fifo< T >::~Fifo

(

)

[virtual]

destructor

Definition at line 120 of file OMKFifo.h.

{
}

---

Member Function Documentation

template<typename T>

const T & OMK::Fifo< T >::getPreceedingValue

(

const unsigned int

indice

)

const [virtual]

get a value before the current value

Parameters:

index

if 0, get the most recent value, if 1, get the preceeding value...

Implements OMK::AbstractFifo< T >.

Definition at line 135 of file OMKFifo.h.

References OMK::AbstractFifo< T >::_fifoSize, OMK::Fifo< T >::_mostRecentValueIndex, OMK::Fifo< T >::_tab, and OMASSERTM.

                                                          {
   OMASSERTM( i < _fifoSize - 2, "" ) ;
   int indice = (_fifoSize + _mostRecentValueIndex - i ) % _fifoSize ;
   return _tab[indice].valeur ;
}

template<typename T>

const Date & OMK::Fifo< T >::getPreceedingDate

(

const unsigned int

indice

)

const [virtual]

get the date associated to a value before the current value

Parameters:

index

if 0, get the date of the most recent value, if 1, get the date associated to the preceeding value...

Implements OMK::AbstractFifo< T >.

Definition at line 127 of file OMKFifo.h.

References OMK::AbstractFifo< T >::_fifoSize, OMK::Fifo< T >::_mostRecentValueIndex, OMK::Fifo< T >::_tab, and OMASSERTM.

{
   OMASSERTM ( i < _fifoSize - 2, "" ) ;
   int indice = (_fifoSize + _mostRecentValueIndex - i ) % _fifoSize ;
   return _tab[indice].dateValeur ;
}

template<typename T>

void OMK::Fifo< T >::set	(	const T &	val,
		const Date &	date
	)			[virtual]

add a value to the fifo

Implements OMK::AbstractFifo< T >.

Definition at line 144 of file OMKFifo.h.

References OMK::AbstractFifo< T >::_fifoSize, OMK::Fifo< T >::_mostRecentValueIndex, OMK::Fifo< T >::_numberOfValues, and OMK::Fifo< T >::_tab.

{
   unsigned int newMostRecentValueIndex = ( _mostRecentValueIndex + 1 ) % _fifoSize ;

   Date & dateOfMostRecentValue( _tab[_mostRecentValueIndex].dateValeur ) ;
   
   if (dateOfMostRecentValue < dateOfNewValue ) {
      _tab[newMostRecentValueIndex].dateValeur = dateOfNewValue ;
      if ( _numberOfValues != _fifoSize ) {
         _numberOfValues ++ ;
      }
    }

   _tab[newMostRecentValueIndex].valeur = newValue ;

   _mostRecentValueIndex = newMostRecentValueIndex ;
}

template<typename T>

void OMK::Fifo< T >::setInPlace	(	const T &	val,
		const Date &	date
	)			[virtual]

make an allready copied value available for reading

Implements OMK::AbstractFifo< T >.

Definition at line 163 of file OMKFifo.h.

References OMK::AbstractFifo< T >::_fifoSize, OMK::Fifo< T >::_mostRecentValueIndex, OMK::Fifo< T >::_numberOfValues, OMK::Fifo< T >::_tab, and OMASSERTM.

{
   unsigned int newMostRecentValueIndex = ( _mostRecentValueIndex + 1 ) % _fifoSize ;

   Date & dateOfMostRecentValue(_tab[_mostRecentValueIndex].dateValeur) ;
   
   if (dateOfMostRecentValue < dateOfNewValue ) {
      _tab[newMostRecentValueIndex].dateValeur = dateOfNewValue ;
      if ( _numberOfValues != _fifoSize ) {
         _numberOfValues ++ ;
      }
    }

   //this assertion will fail if setInplace is used a a different simulation step than getNextPlaceHolder
   // or if newValue isn't a reference to a value of the container
   OMASSERTM(&(_tab[newMostRecentValueIndex].valeur) == &newValue, "" ) ;

   _mostRecentValueIndex = newMostRecentValueIndex ;
}

template<typename T>

T & OMK::Fifo< T >::getNextPlaceHolder

(

)

[virtual]

get a reference to the next place that will be used to store a value

Implements OMK::AbstractFifo< T >.

Definition at line 185 of file OMKFifo.h.

References OMK::AbstractFifo< T >::_fifoSize, OMK::Fifo< T >::_mostRecentValueIndex, and OMK::Fifo< T >::_tab.

{
   return _tab[( _mostRecentValueIndex + 1 ) % _fifoSize].valeur ;
}

template<typename T>

void OMK::Fifo< T >::clear

(

)

[virtual]

clear the file

Implements OMK::AbstractFifo< T >.

Definition at line 210 of file OMKFifo.h.

References OMK::Fifo< T >::_numberOfValues.

                    {
   _numberOfValues = 0 ;
}

template<typename T>

unsigned int OMK::Fifo< T >::getNumberOfPresentValues

(

int

maxCherche = -1

)

const [virtual]

get the number of values in the fifo

Parameters:

lookingFor

the number of values the caller is looking for. If == -1, get all values, otherwise, once lookingFor values are found, that number is returned

Implements OMK::AbstractFifo< T >.

Definition at line 191 of file OMKFifo.h.

References OMK::AbstractFifo< T >::_fifoSize, OMK::Fifo< T >::_numberOfValues, and OMASSERTM.

                                                                     {
   unsigned int res ;
   if ( (maxCherche == -1) || (_numberOfValues < (unsigned int) maxCherche) ) {
      res = _numberOfValues ;
   }
   else {
      res = maxCherche ; 
   }
   //for multithreading reasons, limit the results to _fifoSize - 2 
   OMASSERTM( _fifoSize >=  2, "" ) ;
   if (res >= _fifoSize - 1) {
      res = _fifoSize - 2 ;
   }
   return res ;
}

template<typename T>

void OMK::Fifo< T >::printDebuggingInformation

(

void

)

const [virtual]

printDebuggingInformation print any usefull debugging information

Reimplemented from OMK::AbstractFifo< T >.

Definition at line 217 of file OMKFifo.h.

References OMK::Fifo< T >::_mostRecentValueIndex, and OMK::Fifo< T >::_numberOfValues.

{
   std::cerr<< "Fifo<"<<typeid(T).name()<<">::"<<this<<"::printDebuggingInformation()"<<std::endl ;
   AbstractFifo<T>::printDebuggingInformation() ;
   std::cerr << "number of valid values : " << _numberOfValues << std::endl
        << "last written value at : " << _mostRecentValueIndex << std::endl ;
}

---

Member Data Documentation

template<typename T>

std::vector<ValeurDate> OMK::Fifo< T >::_tab [protected]

the array in wich the values are kept

Definition at line 93 of file OMKFifo.h.

Referenced by OMK::Fifo< T >::getNextPlaceHolder(), OMK::Fifo< T >::getPreceedingDate(), OMK::Fifo< T >::getPreceedingValue(), OMK::Fifo< T >::set(), and OMK::Fifo< T >::setInPlace().

template<typename T>

unsigned int OMK::Fifo< T >::_numberOfValues [protected]

the number of valid values in _tab

Definition at line 96 of file OMKFifo.h.

Referenced by OMK::Fifo< T >::clear(), OMK::Fifo< T >::getNumberOfPresentValues(), OMK::Fifo< T >::printDebuggingInformation(), OMK::Fifo< T >::set(), and OMK::Fifo< T >::setInPlace().

template<typename T>

unsigned int OMK::Fifo< T >::_mostRecentValueIndex [protected]

the place the most recent value was stored

Definition at line 99 of file OMKFifo.h.

Referenced by OMK::Fifo< T >::getNextPlaceHolder(), OMK::Fifo< T >::getPreceedingDate(), OMK::Fifo< T >::getPreceedingValue(), OMK::Fifo< T >::printDebuggingInformation(), OMK::Fifo< T >::set(), and OMK::Fifo< T >::setInPlace().

---