---

PsnMomeReaderFifo.h

Go to the documentation of this file.

/*
 * This file is part of openMask © INRIA, CNRS, Universite de Rennes 1 1993-2002, thereinafter the Software
 * 
 * The Software has been developped within the Siames Project. 
 * INRIA, the University of Rennes 1 and CNRS jointly hold intellectual property rights
 * 
 * The Software has been registered with the Agence pour la Protection des
 * Programmes (APP) under registration number IDDN.FR.001.510008.00.S.P.2001.000.41200
 *
 * This file may be distributed under the terms of the Q Public License
 * version 1.0 as defined by Trolltech AS of Norway and appearing in the file
 * LICENSE.QPL included in the packaging of this file.
 *
 * Licensees holding valid specific licenses issued by INRIA, CNRS or Université de Rennes 1 
 * for the software may use this file in accordance with that specific license 
 *
 */
#ifndef PsnMomeReaderFifoHEADER
#define PsnMomeReaderFifoHEADER

template <typename Type>
class PsnMomeReaderFifo : public PsnMomeFifo<Type>
{
public:
   PsnMomeReaderFifo(const int size, PsnRelaxedMemoryManager * myMemory);
   PsnMomeReaderFifo(void * fifoAddress , const unsigned int size);
   virtual ~PsnMomeReaderFifo() ;

   virtual void set (const Type & val, const PsDate & date) ;

   virtual void setInPlace ( const Type & newValue, const PsDate & date) ;

   virtual Type & getNextPlaceHolder() ;

    unsigned int getNumberOfPresentValues( int maxCherche = -1 ) const ;
   virtual void clear() ;
   virtual void printDebuggingInformation() const ;
protected:
    unsigned int findFirstValid() const ;
   mutable PsDate _dateOfLastValidIndex ;
};


template <typename Type> 
PsnMomeReaderFifo<Type>::PsnMomeReaderFifo(const int size, PsnRelaxedMemoryManager * myMemory) : 
   PsnMomeFifo<Type> (size,myMemory),
   _dateOfLastValidIndex ( PsDate ( -3 ) ) {

}



template <typename Type> 
PsnMomeReaderFifo<Type>::PsnMomeReaderFifo(void * fifoAddress, const unsigned int size) : 
   PsnMomeFifo<Type> (fifoAddress,size),
   _dateOfLastValidIndex ( PsDate ( -3 ) ) {

}



template <typename Type> 
PsnMomeReaderFifo<Type>::~PsnMomeReaderFifo() {

}



template <typename Type> 
unsigned int PsnMomeReaderFifo<Type>::findFirstValid() const {
#ifdef _DEBUGATTRIBUTSMOME
   cerr<<"PsnMomeReaderFifo<"<<typeid(Type).name()<<">::"<<this<<"::findFirstValid ()"<<endl;
#endif
   //findFirstValid only works if _dateOfLastValidIndex and _lastValidIndex have been correctly initialised with a correct pair of values and therefore (*tab)[_lastValidIndex] contains a valid value. This is always true, because nbValues() should be called before this member function is called. if it hasn't been called with a return result greater than 0, then _dateOfLastValidIndex keeps its initial value, explaining the following assertion.
   assert ( _dateOfLastValidIndex != -3 ) ;

   unsigned int lookAt = PsnRelaxedMemoryManager::getReadableQueueIndex() ;

   while ( ((*_tab)[lookAt].dateValeur < _dateOfLastValidIndex) && 
           ( lookAt != _lastValidIndex ) ) {
      lookAt = (lookAt - 1 + _fifoSize) % _fifoSize ;

   }

//     if (lookAt != _lastValidIndex) {
//        _lastValidIndex = lookAt ;
//        _dateOfLastValidIndex = (*_tab)[lookAt].dateValeur ;
//        _dateOfOldestValidValue = (*_tab)[lookAt].datePlusVieilleValeurValide ;
//     }
#ifdef _DEBUGATTRIBUTSMOME
   cerr<<"PsnMomeReaderFifo<"<<typeid(Type).name()<<">::"<<this<<"::findFirstValid () = "<<lookAt<<" : "<<(*_tab)[lookAt].valeur<<endl;
#endif
   return lookAt ;

}



template <typename Type> 
unsigned int PsnMomeReaderFifo<Type>::getNumberOfPresentValues (int maxCherche) const {
#if defined (_DEBUGRELAXEDCOHERANCE) || defined (_DEBUGATTRIBUTSMOME)
   cerr<<"PsnMomeReaderFifo<"<<typeid(Type).name()<<">::"<<this<<"::getNumberOfPresentValues("<<maxCherche<<") "<<endl;
   printDebuggingInformation() ;
#endif 

   bool onLoop = true ;
   unsigned int nbATrouver ;
   if (maxCherche == -1) {
      nbATrouver = _fifoSize ;
   }
   else {
      nbATrouver = maxCherche ; 
   }
   int lookAt ;
   if (_dateOfLastValidIndex != -3 ) {
      lookAt = findFirstValid () ;
   }
   else {
      lookAt = PsnRelaxedMemoryManager::getReadableQueueIndex() ;
   }
   unsigned int nbValidFound = 0 ;

#if defined (_DEBUGRELAXEDCOHERANCE) || defined (_DEBUGATTRIBUTSMOME)
   cerr<<"  lookingAt "<<lookAt<<endl;
   cerr<<"   "<<lookAt<<" : "<<(*_tab)[lookAt].dateValeur<<" "<<(*_tab)[lookAt].datePlusVieilleValeurValide<<" "<<_dateOfOldestValidValue<<" "<<nbValidFound<<endl;
#endif

   if ( (*_tab)[lookAt].dateValeur >= _dateOfOldestValidValue ) {
      //if (lookAt != _lastValidIndex) {
         _lastValidIndex = lookAt ;
         _dateOfLastValidIndex = (*_tab)[lookAt].dateValeur ;
         _dateOfOldestValidValue = (*_tab)[lookAt].datePlusVieilleValeurValide ;
         //}
      long preceedingDate = _dateOfLastValidIndex ;
      nbValidFound++ ;
      //cerr<<(*_tab)[lookAt].valeur<<" "<<(*_tab)[lookAt].dateValeur<<endl;
      if (lookAt != 0 ) {
         lookAt--;
      }
      else {
         lookAt = _fifoSize -1 ;
      }
      while ( ( nbValidFound < nbATrouver) &&
              (lookAt != PsnRelaxedMemoryManager::getReadableQueueIndex() ) &&
              onLoop
              ) {
         if ( (*_tab)[lookAt].dateValeur >= _dateOfOldestValidValue ) {
            if ( (*_tab)[lookAt].dateValeur < preceedingDate ) {
               nbValidFound++ ;
               preceedingDate = (*_tab)[lookAt].dateValeur ;
            }
            else {
               onLoop = false ;
            }
         }
         if (lookAt != 0 ) {
            lookAt--;
         }
         else {
            lookAt = _fifoSize -1 ;
         }
      }
   }
   else {//the FIFO is still being initialised or is corrupt. try to find a valid value in it.
      unsigned int nbLookedAt = 1 ;
      while (nbLookedAt < _fifoSize) {
         if (lookAt != 0 ) {
            lookAt--;
         }
         else {
            lookAt = _fifoSize -1 ;
         }
         if ( (*_tab)[lookAt].dateValeur >=  _dateOfOldestValidValue ) {
            nbValidFound++ ;
            nbLookedAt = _fifoSize ;
#ifdef _DEBUGATTRIBUTSMOME
            cerr<<"PsnMomeReaderFifo<"<<typeid(Type).name()<<">::"<<this<<"::getNumberOfPresentValues : "
                <<"initialising the FIFO's data"<<endl;
            printDebuggingInformation();
#endif
            //initialise the FIFO's data
            _lastValidIndex = lookAt ;
            _dateOfLastValidIndex = (*_tab)[lookAt].dateValeur ;
            _dateOfOldestValidValue = (*_tab)[lookAt].datePlusVieilleValeurValide ;
         }
         else {
            nbLookedAt++ ;
         }
      }
   }
#if defined (_DEBUGRELAXEDCOHERANCE) || defined (_DEBUGATTRIBUTSMOME)
     cerr<<"PsnMomeReaderFifo<"<<typeid(Type).name()<<">::"<<this<<"::getNumberOfPresentValues = "<<nbValidFound<<endl;
#endif
   return nbValidFound ;
}




template <typename Type> 
void PsnMomeReaderFifo<Type>::set (const Type & val, const PsDate & date) {
   cerr<<"PsnMomeReaderFifo<"<<typeid(Type).name()<<">::"<<this<<"::set ("<<val<<", "<<date<<") : double écrivain ! "<<endl;
   assert (false) ;
}


template <typename Type> 
void PsnMomeReaderFifo<Type>::setInPlace(const Type & newValue, const PsDate & date) 
{
   cerr<<"PsnMomeReaderFifo<"<<typeid(Type).name()<<">::"<<this<<"::setInPlace ("<<newValue<<", "<<date<<") : double écrivain ! "<<endl;
   assert (false) ;

}


template <typename Type>
Type & PsnMomeReaderFifo<Type>::getNextPlaceHolder() 
{
   cerr<<"PsnMomeReaderFifo<"<<typeid(Type).name()<<">::"<<this<<"::getNextPlaceHolder () : double écrivain ! "<<endl;
   assert (false) ;
}


template <typename Type> 
void PsnMomeReaderFifo<Type>::clear () {
   cerr<<"PsnMomeReaderFifo<"<<typeid(Type).name()<<">::"<<this<<"::clear() : double écrivain ! "<<endl;
   assert (false) ;
}



template <typename Type> 
void PsnMomeReaderFifo<Type>::printDebuggingInformation () const {
   cerr<<" PsnMomeReaderFifo<"<<typeid(Type).name()<<">::"<<this<<"::printDebuggingInformation () "<<endl;
   PsnMomeFifo<Type>::printDebuggingInformation() ;
   cerr<<"_dateOfLastValidIndex : "<<_dateOfLastValidIndex<<endl;
   cerr<<"readableIndex : "<<PsnRelaxedMemoryManager::getReadableQueueIndex()<<endl; 
   cerr<<"Réaffichage après une vrai synchronisation"<<endl;
   resyncFifo( ( PsnRelaxedMemoryManager *)PsnMemoryManager::whichMemoryManager(_tab) ) ;
   PsnMomeFifo<Type>::printDebuggingInformation() ;   
}

#endif

---