OMKAbstractFifo.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 OMKAbstractFifoHEADER
#define OMKAbstractFifoHEADER

#include "OMKTracer.h"
#include "OMKSimpleTypeT.h"

namespace OMK
{
template <typename T>
class AbstractFifo : public Flowable
{
  
public :
   AbstractFifo (const int taille) ;


   virtual ~AbstractFifo () ;


   virtual int getMaximumNumberOfValues() const ;


   virtual unsigned int getNumberOfPresentValues( int lookingFor = -1 ) const = 0 ;


   virtual const T& getPreceedingValue (const unsigned int index) const = 0 ;


   virtual const Date & getPreceedingDate(const unsigned int indice) const = 0 ;
   

   virtual void set (const T& val, const Date & date) = 0 ;


   virtual void setInPlace ( const T& val, const Date & date) = 0 ;


   virtual T& getNextPlaceHolder() = 0 ;


   virtual void clear () = 0 ;


   virtual void printDebuggingInformation(void) const ;


   virtual void extract (std::istream & = std::cin) ;
   

   virtual void insertInStream (std::ostream & = std::cout) const  ;
  
   virtual void unpack (IncomingSynchronisationMessage &) ;
   
   virtual void pack (OutgoingSynchronisationMessage &) const ;

   virtual void unpackAllValues (IncomingSynchronisationMessage &) ;
   
   virtual void packAllValues (OutgoingSynchronisationMessage &) const ;

protected :
   unsigned int _fifoSize ;

} ; // AbstractFifo
}// namespace OMK

//because everything is template, #include all the Existing FIFO here. 

#include <OMKFifo.h>
#include <OMKIncomingSynchronisationMessage.h>
#include <OMKSimpleTypeT.inl>
namespace OMK
{
template <typename T> 
int AbstractFifo<T>::getMaximumNumberOfValues() const {
   return _fifoSize ;
}

template <typename T> 
AbstractFifo<T>::AbstractFifo (const int taille) : _fifoSize ( taille ) {

}

template <typename T>
AbstractFifo<T>::~AbstractFifo ( ) {

} 

template <typename T>
void AbstractFifo<T>::printDebuggingInformation() const 
{
   std::cerr<< "Capacity of fifo : "<<_fifoSize<<std::endl;
}

//------------------------------------------------------------------------

template <typename T>
void AbstractFifo<T>::extract (std::istream & in) {
   Date dateDerniereVal;
   T data;
   in >> dateDerniereVal >> data ;
   set(data, dateDerniereVal);
}


   
template <typename T>
void AbstractFifo<T>::insertInStream (std::ostream & out) const 
{
   out << getPreceedingDate (0) << " "<<getPreceedingValue (0) << " ";
}


template <typename T>
void AbstractFifo<T>::unpack (IncomingSynchronisationMessage & in) 
{
   T& receivedValue ( getNextPlaceHolder() ) ;
   receivedValue.unpack( in ) ;
   setInPlace( receivedValue, in.getMessageDate() );
}
   
template <typename T>
void AbstractFifo<T>::unpackAllValues (IncomingSynchronisationMessage & in) 
{
   T& receivedValue ( getNextPlaceHolder() ) ;
   OMK::Type::SimpleTypeT< Date > dateOfReceivedValue ;
   dateOfReceivedValue.unpack ( in ) ;
   receivedValue.unpack( in ) ;
   setInPlace( receivedValue , dateOfReceivedValue );
}
   
template <typename T>
void AbstractFifo<T>::pack (OutgoingSynchronisationMessage & out ) const 
{
   getPreceedingValue (0).pack (out) ;
}

template <typename T>
void AbstractFifo<T>::packAllValues (OutgoingSynchronisationMessage & out ) const 
{
   // implement in a minimal fashion
  OMK::Type::SimpleTypeT< Date >( getPreceedingDate( 0 ) ).pack(out) ;
   getPreceedingValue (0).pack (out) ;
}
} // namespace OMK
#endif

---