OMK::AbstractFifo< T > Class Template Reference

Abstract Fifo used to store attribute history information For thread safety reasons, this class should ensure that multiple reads and one write can be done in concurrent fashion and with coherant results. More...

#include <OMKAbstractFifo.h>

Inheritance diagram for OMK::AbstractFifo< T >:

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

[legend]List of all members.

Public Member Functions
	AbstractFifo (const int taille)
	constructor
virtual	~AbstractFifo ()
	destructor
virtual int	getMaximumNumberOfValues () const
	get the size of the fifo
virtual unsigned int	getNumberOfPresentValues (int lookingFor=-1) const=0
	get the number of values in the fifo
virtual const T &	getPreceedingValue (const unsigned int index) const=0
	get a value before the current value
virtual const Date &	getPreceedingDate (const unsigned int indice) const=0
	get the date associated to a value before the current value
virtual void	set (const T &val, const Date &date)=0
	add a value to the fifo
virtual void	setInPlace (const T &val, const Date &date)=0
	make an allready copied value available for reading
virtual T &	getNextPlaceHolder ()=0
	get a reference to the next place that will be used to store a value
virtual void	clear ()=0
	clear the fifo
virtual void	printDebuggingInformation (void) const
	printDebuggingInformation print any usefull debugging information
virtual void	extract (std::istream &=std::cin)
	extract from an input stream
virtual void	insertInStream (std::ostream &=std::cout) const
	insert in a output stream
virtual void	unpack (IncomingSynchronisationMessage &)
	unpack an update from a message (suppose the value's timestamp is the message's timestamp
virtual void	pack (OutgoingSynchronisationMessage &) const
	pack in an update message
virtual void	unpackAllValues (IncomingSynchronisationMessage &)
	unpack a complete (implemented in a minimal fashion) from a message
virtual void	packAllValues (OutgoingSynchronisationMessage &) const
	pack a complete message
Protected Attributes
unsigned int	_fifoSize
	Number of values that can be contained in the FIFO.

---

Detailed Description

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

Abstract Fifo used to store attribute history information For thread safety reasons, this class should ensure that multiple reads and one write can be done in concurrent fashion and with coherant results.

Definition at line 30 of file OMKAbstractFifo.h.

---

Constructor & Destructor Documentation

template<typename T>

OMK::AbstractFifo< T >::AbstractFifo

(

const int

taille

)

constructor

Definition at line 124 of file OMKAbstractFifo.h.

                                               : _fifoSize ( taille ) {

}

template<typename T>

OMK::AbstractFifo< T >::~AbstractFifo

(

)

[virtual]

destructor

Definition at line 129 of file OMKAbstractFifo.h.

                                 {

} 

---

Member Function Documentation

template<typename T>

int OMK::AbstractFifo< T >::getMaximumNumberOfValues

(

)

const [virtual]

get the size of the fifo

Definition at line 119 of file OMKAbstractFifo.h.

References OMK::AbstractFifo< T >::_fifoSize.

                                                    {
   return _fifoSize ;
}

template<typename T>

virtual unsigned int OMK::AbstractFifo< T >::getNumberOfPresentValues

(

int

lookingFor = -1

)

const [pure 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

Implemented in OMK::Fifo< T >.

template<typename T>

virtual const T& OMK::AbstractFifo< T >::getPreceedingValue

(

const unsigned int

index

)

const [pure virtual]

get a value before the current value

Parameters:

index

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

Implemented in OMK::Fifo< T >.

Referenced by OMK::AbstractFifo< T >::insertInStream(), OMK::AbstractFifo< T >::pack(), and OMK::AbstractFifo< T >::packAllValues().

template<typename T>

virtual const Date& OMK::AbstractFifo< T >::getPreceedingDate

(

const unsigned int

indice

)

const [pure 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...

Implemented in OMK::Fifo< T >.

Referenced by OMK::AbstractFifo< T >::insertInStream(), and OMK::AbstractFifo< T >::packAllValues().

template<typename T>

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

add a value to the fifo

Implemented in OMK::Fifo< T >.

Referenced by OMK::AbstractFifo< T >::extract().

template<typename T>

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

make an allready copied value available for reading

Implemented in OMK::Fifo< T >.

Referenced by OMK::AbstractFifo< T >::unpack(), and OMK::AbstractFifo< T >::unpackAllValues().

template<typename T>

virtual T& OMK::AbstractFifo< T >::getNextPlaceHolder

(

)

[pure virtual]

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

Implemented in OMK::Fifo< T >.

Referenced by OMK::AbstractFifo< T >::unpack(), and OMK::AbstractFifo< T >::unpackAllValues().

template<typename T>

virtual void OMK::AbstractFifo< T >::clear

(

)

[pure virtual]

clear the fifo

Implemented in OMK::Fifo< T >.

template<typename T>

void OMK::AbstractFifo< T >::printDebuggingInformation

(

void

)

const [virtual]

printDebuggingInformation print any usefull debugging information

Reimplemented in OMK::Fifo< T >.

Definition at line 134 of file OMKAbstractFifo.h.

References OMK::AbstractFifo< T >::_fifoSize.

{
   std::cerr<< "Capacity of fifo : "<<_fifoSize<<std::endl;
}

template<typename T>

void OMK::AbstractFifo< T >::extract

(

std::istream &

= std::cin

)

[virtual]

extract from an input stream

Implements OMK::Flowable.

Definition at line 142 of file OMKAbstractFifo.h.

References OMK::AbstractFifo< T >::set().

                                              {
   Date dateDerniereVal;
   T data;
   in >> dateDerniereVal >> data ;
   set(data, dateDerniereVal);
}

template<typename T>

void OMK::AbstractFifo< T >::insertInStream

(

std::ostream &

= std::cout

)

const [virtual]

insert in a output stream

Implements OMK::Flowable.

Definition at line 152 of file OMKAbstractFifo.h.

References OMK::AbstractFifo< T >::getPreceedingDate(), and OMK::AbstractFifo< T >::getPreceedingValue().

{
   out << getPreceedingDate (0) << " "<<getPreceedingValue (0) << " ";
}

template<typename T>

void OMK::AbstractFifo< T >::unpack

(

IncomingSynchronisationMessage &

)

[virtual]

unpack an update from a message (suppose the value's timestamp is the message's timestamp

Reimplemented from OMK::Flowable.

Definition at line 159 of file OMKAbstractFifo.h.

References OMK::IncomingSynchronisationMessage::getMessageDate(), OMK::AbstractFifo< T >::getNextPlaceHolder(), and OMK::AbstractFifo< T >::setInPlace().

{
   T& receivedValue ( getNextPlaceHolder() ) ;
   receivedValue.unpack( in ) ;
   setInPlace( receivedValue, in.getMessageDate() );
}

template<typename T>

void OMK::AbstractFifo< T >::pack

(

OutgoingSynchronisationMessage &

)

const [virtual]

pack in an update message

Reimplemented from OMK::Flowable.

Definition at line 177 of file OMKAbstractFifo.h.

References OMK::AbstractFifo< T >::getPreceedingValue().

Referenced by OMK::AbstractFifo< T >::packAllValues().

{
   getPreceedingValue (0).pack (out) ;
}

template<typename T>

void OMK::AbstractFifo< T >::unpackAllValues

(

IncomingSynchronisationMessage &

)

[virtual]

unpack a complete (implemented in a minimal fashion) from a message

Definition at line 167 of file OMKAbstractFifo.h.

References OMK::AbstractFifo< T >::getNextPlaceHolder(), OMK::AbstractFifo< T >::setInPlace(), and OMK::Type::SimpleTypeT< T >::unpack().

{
   T& receivedValue ( getNextPlaceHolder() ) ;
   OMK::Type::SimpleTypeT< Date > dateOfReceivedValue ;
   dateOfReceivedValue.unpack ( in ) ;
   receivedValue.unpack( in ) ;
   setInPlace( receivedValue , dateOfReceivedValue );
}

template<typename T>

void OMK::AbstractFifo< T >::packAllValues

(

OutgoingSynchronisationMessage &

)

const [virtual]

pack a complete message

Definition at line 183 of file OMKAbstractFifo.h.

References OMK::AbstractFifo< T >::getPreceedingDate(), OMK::AbstractFifo< T >::getPreceedingValue(), and OMK::AbstractFifo< T >::pack().

{
   // implement in a minimal fashion
  OMK::Type::SimpleTypeT< Date >( getPreceedingDate( 0 ) ).pack(out) ;
   getPreceedingValue (0).pack (out) ;
}

---

Member Data Documentation

template<typename T>

unsigned int OMK::AbstractFifo< T >::_fifoSize [protected]

Number of values that can be contained in the FIFO.

Definition at line 106 of file OMKAbstractFifo.h.

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

---