---

PsOutput< Type > Class Template Reference

An output of a certain type for a simulated object. More...

#include <PsOutput.h>

Inheritance diagram for PsOutput< Type >:

[legend]Collaboration diagram for PsOutput< Type >:

[legend]List of all members.

Public Methods
	PsOutput (const PsName &outputName, PsSimulatedObject &owner, const int historySize, PsPolatorNT *polator=NULL)
	Constructor.
virtual	~PsOutput (void)
	Destructor.
virtual const Type &	get (int &distanceToExactValue, const int precisionLevel, const PsDate &deltaT, Type &calculatedResult) const
	get a value for this output
virtual const Type &	getLastExactValue () const
	get the last exact value produced and stored in this output
virtual const PsDate &	getDateOfLastExactValue () const
	get the date of the last exact value produced and stored in this output
virtual void	set (const Type &newValue)
	publish a new value through this output
virtual void	suggest (const Type &suggestedValue)
	used by an input to suggest an initial value if none has yet been produced
virtual Type &	getNextPlaceHolder ()
	get a reference to the next place that will be used to store a value.
virtual void	setInPlace (const Type &)
	zero copy set for values wich have been calculated using the reference obtained by getNextPlaceHolder
virtual void	connectedMyself (PsInputNT *input)
	called by an input when it connects to this output
virtual void	disconnectedMyself (PsInputNT *input)
	called by an input when it disconnects from this output
virtual void	printDebuggingInformation (ostream &err) const
	print debugging info
void	printHistory () const
	print all the stored values
virtual void	empty ()
	empty all the stored values
coding and decoding the output values from and to streams
virtual void	extract (istream &=cin)
	extract new values from a stream
virtual void	insertInStream (ostream &=cout) const
	insert latest value in a stream
virtual void	pack (PsOutgoingSynchronisationMessage &) const
	pack value in a PvmMessage ( should be delegated to a pvm output ) packs the name of the output, then any usefull update information
virtual void	packAllValues (PsOutgoingSynchronisationMessage &) const
	pack value in a PvmMessage ( should be delegated to a pvm output ) packs the name of the output, then all initial information
virtual void	unpack (PsIncomingSynchronisationMessage &)
	unpack value from a PvmMessage ( should be delegated to a pvm output ) shouldn't unpack the name, but all other usefull information packed
virtual void	unpackAllValues (PsIncomingSynchronisationMessage &)
	unpack value from a PvmMessage ( should be delegated to a pvm output ) shouldn't unpack the name, but all other usefull information packed
alias management
virtual void	setUsedOutput (PsOutput< Type > *output)
	change the output read by internal get
virtual void	setAlias (PsOutputAlias< Type > *output)
	set the direct alias of this output
virtual void	unsetAlias ()
	cancel aliasing
virtual PsOutput< Type > *	getUsedOutput (void) const
	get the output used by internal get
virtual PsOutputAlias< Type > *	getAlias (void) const
	get the direct alias of this output
Public Attributes
PsPolator< Type > *	_polator
	the associated polator
Protected Methods
virtual void	setValidity (bool)
	setValidity.
virtual void	notifyConnectedSensitiveInputs ()
	alert any sensitive input of a change of value
virtual const Type &	localGet (int &validiteRes, const int niveauInterpol, const PsDate &deltaT, Type &resultPlaceHolder) const
	this is the get that accesses the local history fifo, whether the output is aliased or not
virtual void	localInsert (ostream &=cout) const
	an insert that changes the local history fifo
Protected Attributes
PsOutputAlias< Type > *	_aliasOfOutput
	a pointer to the primary alias of this output
PsOutput< Type > *	_usedOutput
	the output read by get
PsnAbstractFifo< Type > *	_history
	the history storing fifo
const PsDate &	_date
	a reference to the current date
list< PsSensitiveInput< Type > * >	_listOfConnectedSensitiveInputs
	the list of connected sensitive inputs
list< PsInput< Type > * >	_listOfConnectedUnsensitiveInputs
	the list of connected unsensitive inputs
bool	_sensitiveInputsConnected
	a boolean indicating is sensible inputs are connected
PsnMutexLock	_myMutex
	A mutual exclusion lock to protect local data from corruption in a multithreaded environment Need to be protected : _listOfConnectedSensitiveInputs, outputAsc.
bool	_validity
	a boolean indicating presence of values in the fifo
Friends
class	PsOutputAlias< Type >
	friend declaration so thah aliases can notify the sensitive inputs connected to their aliased output

---

Detailed Description

template<typename Type>
class PsOutput< Type >

An output of a certain type for a simulated object.

template parameter must be of a derived class of PsType

See also:

PsType

2001/03/07 (march 2001) : thread safety assessement of this class by David Margery : provided the owner of a PsOutput doesn't use multithreaded access to an output (through set and insert for example), and that the owned PsInterpolator can have concurrent access to the owned PsnAbstractFifo (aka. PsnAbstractFifo) (this should be ensured by the fifo which should enable concurrent reads and writes ), this class is thread safe. Beware, in a multithreaded context more PsUnInitialisedOutputException could be generated at initialisation time and after a clear()

Author:

Thierry Duval (version 2.0)

Version:

2.6 (revision $revision)

• 2.0 -> 2.1 by O. Filangi : added alias support
• 2.1 -> 2.2 by David Margery : added change detection and robust destruction from the input point of view
• 2.2 -> 2.3 by David Margery : added getLastExactValue, setInPlace, getNextPlaceHolder
• 2.3 -> 2.4 by David Margery : moved support for aliases of aliases to PsOutputAlias
• 2.4 -> 2.5 by David Margery : added getDateOfLastExactValue
• 2.5 -> 2.6 by David Margery (on the 2002/06/04) : added support for virtual inheritance of PsAttribute, and support for the distinction between initial synchronisation messages and update synchronisation messages

Definition at line 53 of file PsOutput.h.

---

Constructor & Destructor Documentation

template<typename Type> PsOutput< Type >::PsOutput (  const PsName &    outputName, PsSimulatedObject &    owner, const int    historySize, PsPolatorNT *    polator = NULL )  [inline]

Constructor. Parameters: outputName  the name of this output owner  the owner of this output historySize  size of the fifo associated Polator  a Polator, in case we want to replace the default one provided by Type Definition at line 262 of file PsOutput.h. References PsOutput< Type >::_history, PsOutput< Type >::_polator, PsOutput< Type >::_usedOutput, and PsAttribute::getName(). : PsAttribute(owner, outputName), PsOutputNT (owner, outputName), _aliasOfOutput ( NULL ), _date ( owner.getController().getSimulatedDate() ), _sensitiveInputsConnected ( false ), _validity ( false ) { /* thread safety assessement : thread safe because only on construction of the object */ #ifdef _DEBUGTYPEUTIL cout << "PsOutput<Type>::PsOutput () constructor" << endl; #endif if ( polator == NULL ) // tous les types ont une methode static qui crait leur polator par defaut { Type aTypeInstance ; // because createPolator isn't static _polator = static_cast<PsPolator <Type> *>(aTypeInstance.createPolator()) ; if ( _polator==NULL ) { cerr<<"PsOutput<"<<typeid(Type).name()<<">::PsOutput : the created polator of " <<typeid(aTypeInstance).name()<<" isn't of type PsPolator <"<<typeid(Type).name()<<"> *"<<endl; } } else { _polator = dynamic_cast<PsPolator <Type> *>(polator) ; if (_polator==NULL) { cerr<<"PsOutput<"<<typeid(Type).name()<<">::PsOutput : the created polator of type " <<typeid(polator).name()<<" isn't of type PsPolator <"<<typeid(Type).name()<<"> *"<<endl; } } if (_polator==NULL) { cerr<<"PsOutput<"<<typeid(Type).name()<<">::PsOutput : problem in creating the appropriate polator for output "<<getName()<<endl; } // calculate the appropriate history fifo length int realSize = historyLength + _polator->getNumberOfNeededValuesForMaxPrecisionPolation(); _history = new PsnFifo < Type > (realSize) ; _polator->setFifo(_history); _usedOutput = this ;

template<typename Type> PsOutput< Type >::~PsOutput (  void    )  [inline, virtual]

Destructor. Definition at line 325 of file PsOutput.h. References PsOutput< Type >::_aliasOfOutput, PsOutput< Type >::_history, PsOutput< Type >::_listOfConnectedSensitiveInputs, PsOutput< Type >::_listOfConnectedUnsensitiveInputs, PsOutput< Type >::_myMutex, list< PsInput< Type > * >::begin(), list< PsSensitiveInput< Type > * >::begin(), list< PsInput< Type > * >::end(), list< PsSensitiveInput< Type > * >::end(), PsnMutexLock::protect(), and PsnMutexLock::unprotect(). { /* thread safety assessement : thread safe because only one destruction of the object */ #ifdef _TYPENAMENOTIMPLICIT typename #endif list<PsSensitiveInput <Type> *>::iterator i; _myMutex.protect() ; for (i = _listOfConnectedSensitiveInputs.begin(); i != _listOfConnectedSensitiveInputs.end(); i++) { (*i)->outputDestroyed(); } #ifdef _TYPENAMENOTIMPLICIT typename #endif list<PsInput <Type> *>::iterator j; for (j = _listOfConnectedUnsensitiveInputs.begin(); j != _listOfConnectedUnsensitiveInputs.end(); j++) { (*j)->outputDestroyed(); } _myMutex.unprotect() ; if ( _aliasOfOutput != NULL ) _aliasOfOutput->aliasedOutputDeleted () ; if ( _history != NULL ) delete _history ;

---

Member Function Documentation

template<typename Type> void PsOutput< Type >::connectedMyself (  PsInputNT *    input )  [virtual]

called by an input when it connects to this output Implements PsOutputNT. Definition at line 521 of file PsOutput.h. References PsOutput< Type >::_listOfConnectedSensitiveInputs, PsOutput< Type >::_listOfConnectedUnsensitiveInputs, PsOutput< Type >::_myMutex, PsOutput< Type >::_sensitiveInputsConnected, PsnMutexLock::protect(), list< PsInput< Type > * >::push_back(), list< PsSensitiveInput< Type > * >::push_back(), PsAttribute::touch(), and PsnMutexLock::unprotect(). { /* thread safety assessement : critical data is mutex protected */ touch() ; PsSensitiveInput <Type> * inputSensible=dynamic_cast< PsSensitiveInput <Type> *>(input); if (inputSensible!=NULL) { #ifdef _DEBUGALIAS cerr<<"PsOutput<Type>::connectedMyself"<<input<<endl; #endif _myMutex.protect () ; _listOfConnectedSensitiveInputs.push_back(inputSensible); _sensitiveInputsConnected = true ; _myMutex.unprotect () ; } else { _myMutex.protect () ; PsInput<Type> * standardInput = dynamic_cast<PsInput<Type> *> (input) ; assert (standardInput != NULL ) ; _listOfConnectedUnsensitiveInputs.push_back ( standardInput ) ; _myMutex.unprotect () ; }

template<typename Type> void PsOutput< Type >::disconnectedMyself (  PsInputNT *    input )  [virtual]

called by an input when it disconnects from this output Implements PsOutputNT. Definition at line 556 of file PsOutput.h. References PsOutput< Type >::_listOfConnectedSensitiveInputs, PsOutput< Type >::_listOfConnectedUnsensitiveInputs, PsOutput< Type >::_myMutex, PsOutput< Type >::_sensitiveInputsConnected, list< PsSensitiveInput< Type > * >::empty(), PsnMutexLock::protect(), list< PsInput< Type > * >::remove(), list< PsSensitiveInput< Type > * >::remove(), and PsnMutexLock::unprotect(). { #ifdef _DEBUGALIAS cerr<<"PsOutput<Type>::disconnectedMyself"<<endl; #endif /* thread safety assessement : critical data is mutex protected */ PsSensitiveInput <Type> * inputSensible=dynamic_cast< PsSensitiveInput <Type> *>(input); if (inputSensible!=NULL) { _myMutex.protect () ; _listOfConnectedSensitiveInputs.remove(inputSensible); if ( _listOfConnectedSensitiveInputs.empty() ) _sensitiveInputsConnected = false ; _myMutex.unprotect () ; } else { _myMutex.protect () ; PsInput <Type> * unsensitiveInput = dynamic_cast< PsInput <Type> *>(input); _listOfConnectedUnsensitiveInputs.remove(unsensitiveInput); _myMutex.unprotect () ; }

template<typename Type> void PsOutput< Type >::empty (    )  [inline, virtual]

empty all the stored values Definition at line 812 of file PsOutput.h. References PsOutput< Type >::_history, PsAttribute::_owner, PsAttribute::getName(), and PsOutput< Type >::setValidity(). { /* thread safety assessement : as thread safe as clear of fifo. Only one simultaneous acces possible (in theory). */ // MIPSPRO 7.3.1.2 workaround static PsSensitiveInput<Type> toto (getName(), _owner, false) ; _history->clear () ; setValidity(false) ;

template<typename Type> void PsOutput< Type >::extract (  istream &    = cin )  [inline, virtual]

extract new values from a stream Implements PsAttribute. Reimplemented in PsMomeOutput< Type >. Definition at line 632 of file PsOutput.h. References PsOutput< Type >::_history, PsOutput< Type >::notifyConnectedSensitiveInputs(), and PsOutput< Type >::setValidity(). { /* thread safety assessement : localGet and extract could collide. Thread safety can only be assured if the fifo and the interpolator are thread safe with respect to the values in the fifo. only one extract at a time. */ if (_validity) { const Type & oldValue=_history->getPreceedingValue(0); in >> *_history ; if(_history->getPreceedingValue(0)!=oldValue) //double extract won't happen { notifyConnectedSensitiveInputs(); } } else { in >> *_history ; setValidity(true) ; notifyConnectedSensitiveInputs(); }

template<typename Type> const Type & PsOutput< Type >::get (  int &    distanceToExactValue, const int    precisionLevel, const PsDate &    deltaT, Type &    calculatedResult )  const [inline, virtual]

get a value for this output Parameters: distanceToExactValue  where to store the distance to the nearest exact value returned by get precisionLevel  the degre of precision of any polation operation deltaT  age of the desired value seeked for calculatedResult  placeholder for any calculated result Returns: a reference to the desired result Reimplemented in PsMomeOutput< Type >, and PsNullOutput< Type >. Definition at line 439 of file PsOutput.h. References PsOutput< Type >::_history, PsOutput< Type >::getUsedOutput(), and PsDate. Referenced by PsMomeOutput< Type >::get(). { /* thread safety assessement : As thread safe as localGet */ #ifdef _DEBUGTYPEUTIL cerr<<"PsOutput<Type>::get"<<endl; cerr<<"OutputUtilisée : "<<getUsedOutpute()<<endl; cerr<<"file : "<<_history<<endl; _history->printDebuggingInformation() ; informations(); #endif assert( getUsedOutput () != NULL ) ; return getUsedOutput ()->localGet(validiteRes,niveauInterpol,deltaT,resultPlaceHolder);

template<typename Type> PsOutputAlias< Type > * PsOutput< Type >::getAlias (  void    )  const [inline, virtual]

get the direct alias of this output Definition at line 427 of file PsOutput.h. References PsOutput< Type >::_aliasOfOutput. Referenced by PsOutput< Type >::printDebuggingInformation(). { /* thread safety assessement : protected method multiple simultaneous access possible, but as long as this method is only used onced by each access patern, the PsOuptut stays coherant */ return _aliasOfOutput ;

template<typename Type> const PsDate & PsOutput< Type >::getDateOfLastExactValue (    )  const [inline, virtual]

get the date of the last exact value produced and stored in this output Reimplemented in PsNullOutput< Type >. Definition at line 843 of file PsOutput.h. References PsOutput< Type >::_history, PsAttribute::_owner, PsName::getCString(), PsSimulatedObject::getName(), HeapStackTop::getSystemMemoryManager(), PsDate, and PsAttribute::touch(). { touch() ; // this bypasses any Polator if (_history->getNumberOfPresentValues(1) >= 1 ) //if a value is stored { return _history->getPreceedingDate ( 0 ) ; } else { HeapStackTop usualContext(HeapStackTop::getSystemMemoryManager() ); PsUnInitialisedOutputException exception(*this,"PsOutput<Type>::getLastExactValue\n"); exception<<"Impossible to get a value from an uninitialised output of "<<_owner.getName().getCString(); throw exception; }

template<typename Type> const Type & PsOutput< Type >::getLastExactValue (    )  const [inline, virtual]

get the last exact value produced and stored in this output Reimplemented in PsNullOutput< Type >. Definition at line 824 of file PsOutput.h. References PsOutput< Type >::_history, PsAttribute::_owner, PsName::getCString(), PsSimulatedObject::getName(), HeapStackTop::getSystemMemoryManager(), and PsAttribute::touch(). { touch() ; // this bypasses any Polator if (_history->getNumberOfPresentValues(1) >= 1 ) //if a value is stored { return _history->getPreceedingValue ( 0 ) ; } else { HeapStackTop usualContext(HeapStackTop::getSystemMemoryManager()); PsUnInitialisedOutputException exception(*this,"PsOutput<Type>::getLastExactValue\n"); exception<<"Impossible to get a value from an uninitialised output of "<<_owner.getName().getCString(); throw exception; }

template<typename Type> Type & PsOutput< Type >::getNextPlaceHolder (    )  [inline, virtual]

get a reference to the next place that will be used to store a value. Using the obtained reference enables a zero copy set (using setInPlace) if the new value is directly calculated using that reference. Definition at line 862 of file PsOutput.h. References PsOutput< Type >::_history. { return _history->getNextPlaceHolder() ;

template<typename Type> PsOutput< Type > * PsOutput< Type >::getUsedOutput (  void    )  const [inline, virtual]

get the output used by internal get Definition at line 414 of file PsOutput.h. References PsOutput< Type >::_usedOutput. Referenced by PsOutput< Type >::get(), PsOutput< Type >::insertInStream(), and PsOutput< Type >::printDebuggingInformation(). { /* thread safety assessement : protected method multiple simultaneous access possible, but as long as this method is only used onced by each access patern, the PsOuptut stays coherant */ return _usedOutput ;

template<typename Type> void PsOutput< Type >::insertInStream (  ostream &    = cout )  const [inline, virtual]

insert latest value in a stream Implements PsAttribute. Definition at line 755 of file PsOutput.h. References PsOutput< Type >::getUsedOutput(). { /*thread safety assessement : As thread safe as localInsert */ cerr<<"PsOutput<Type>::insertInStream"<<endl; getUsedOutput()->localInsert(out);

template<typename Type> const Type & PsOutput< Type >::localGet (  int &    validiteRes, const int    niveauInterpol, const PsDate &    deltaT, Type &    resultPlaceHolder )  const [protected, virtual]

this is the get that accesses the local history fifo, whether the output is aliased or not Definition at line 461 of file PsOutput.h. References PsAttribute::_owner, PsOutput< Type >::_polator, PsOutput< Type >::_validity, PsSimulatedObject::getController(), PsController::getSimulatedDate(), HeapStackTop::getSystemMemoryManager(), PsDate, and PsAttribute::touch(). { /* thread safety assessement : As thread safe as polate from PsInterplateur. But be careful : in a multithreaded environment this member function can generate more exceptions than expected */ touch() ; if (!_validity) { HeapStackTop usualContext( HeapStackTop::getSystemMemoryManager() ); PsUnInitialisedOutputException exception(*this,"PsOutput<Type>::localGet \n"); throw exception; } else { #ifdef _DEBUGTYPEUTIL cerr<<"PsOutput<Type>::localGet"<<endl; cerr<<owner.getController().getSimulatedDate()<<endl; cerr<<"Interpolateur : "<<_polator<<endl; #endif PsDate date = _owner.getController().getSimulatedDate() - deltaT ; return _polator->polate(niveauInterpol, date,validiteRes, resultPlaceHolder); }

template<typename Type> void PsOutput< Type >::localInsert (  ostream &    = cout )  const [inline, protected, virtual]

an insert that changes the local history fifo Definition at line 765 of file PsOutput.h. References PsOutput< Type >::_history, PsAttribute::_owner, PsOutput< Type >::_validity, PsName::getCString(), PsSimulatedObject::getName(), and HeapStackTop::getSystemMemoryManager(). { /* thread safety assement thread safe : collides with set on the PsnAbstractFifo. But they should only be activated by the owner. So as lmong as the owner isn't multithreaded... nota : in a multithreaded environment this member function could generate more exceptions than expected */ if (!_validity) { HeapStackTop usualContext(HeapStackTop::getSystemMemoryManager() ); PsUnInitialisedOutputException exception(*this,"PsOutput<Type>::localInsert\n"); exception<<"Cannot read uninitailised output of "<<_owner.getName().getCString(); throw exception; } else { out << *_history << " " ; }

template<typename Type> void PsOutput< Type >::notifyConnectedSensitiveInputs (    )  [protected, virtual]

alert any sensitive input of a change of value Reimplemented in PsOutputAlias< Type >. Definition at line 489 of file PsOutput.h. References PsOutput< Type >::_listOfConnectedSensitiveInputs, PsOutput< Type >::_myMutex, list< PsSensitiveInput< Type > * >::begin(), list< PsSensitiveInput< Type > * >::end(), PsnMutexLock::protect(), PsAttribute::touch(), and PsnMutexLock::unprotect(). Referenced by PsOutput< Type >::extract(), PsOutputAlias< Type >::notifyConnectedSensitiveInputs(), PsOutput< Type >::set(), PsOutput< Type >::setInPlace(), PsOutput< Type >::suggest(), PsOutput< Type >::unpack(), and PsOutput< Type >::unpackAllValues(). { /* thread safety assessement : mutex protected */ if ( _sensitiveInputsConnected ) { // with sensitive inputs connected, it is as if the output value was read at each step touch() ; #ifdef _TYPENAMENOTIMPLICIT typename #endif list<PsSensitiveInput <Type> *>::iterator i; _myMutex.protect() ; for (i=_listOfConnectedSensitiveInputs.begin() ; i!=_listOfConnectedSensitiveInputs.end() ; i++ ) { #ifdef _DEBUGALIAS cerr<<"PsOutput<Type>::notifyConnectedSensitiveInputs : one to notify"<<endl; #endif (*i)->signalChange(); #ifdef _DEBUGALIAS cerr<<"PsOutput<Type>::notifyConnectedSensitiveInputs : one notified"<<endl; #endif } _myMutex.unprotect() ; }

template<typename Type> void PsOutput< Type >::pack (  PsOutgoingSynchronisationMessage &    )  const [virtual]

pack value in a PvmMessage ( should be delegated to a pvm output ) packs the name of the output, then any usefull update information Reimplemented from PsFlowable. Definition at line 657 of file PsOutput.h. References PsOutput< Type >::_history, PsOutgoingSynchronisationMessage::getMessageDate(), PsAttribute::getName(), and PsName::pack(). { //cerr<<"PsOutput<Type>::pack"<<endl; //packs the name of the output, then any usefull information /* thread safety assement thread safe : collides with set and localInsert on the PsnAbstractFifo. But they should only be activated by the owner. So as long as the owner isn't multithreaded... nota : in a multithreaded environment this member function could generate more exceptions than expected */ if (_validity) { if ( out.getMessageDate() == _history->getPreceedingDate ( 0 ) ) { getName ().pack ( out ) ; _history->pack( out ) ; } } //else : do not pack anything, therefore mirror will remain uninitialised // cerr<<"PsOutput<Type>:"<<this<<":pack done"<<endl;

template<typename Type> void PsOutput< Type >::packAllValues (  PsOutgoingSynchronisationMessage &    )  const [virtual]

pack value in a PvmMessage ( should be delegated to a pvm output ) packs the name of the output, then all initial information Implements PsOutputNT. Definition at line 680 of file PsOutput.h. References PsOutput< Type >::_history, PsAttribute::getName(), and PsName::pack(). { //cerr<<"PsOutput<Type>::packAllValues"<<endl; //packs the name of the output, then all initial information /* thread safety assement thread safe : collides with set and localInsert on the PsnAbstractFifo. But they should only be activated by the owner. So as long as the owner isn't multithreaded, or that the kernel doesn't call this member function during activation of the owner... nota : in a multithreaded environment this member function could generate more exceptions than expected */ if (_validity) { getName ().pack ( out ) ; _history->packAllValues( out ) ; } //else : do not pack anything, therefore mirror will remain uninitialised // cerr<<"PsOutput<Type>:"<<this<<":packAllVAlues done"<<endl;

template<typename Type> void PsOutput< Type >::printDebuggingInformation (  ostream &    err )  const [inline, virtual]

print debugging info Parameters: the  output stream on which to print debugging information Implements PsAttribute. Definition at line 794 of file PsOutput.h. References PsOutput< Type >::_history, PsAttribute::_name, PsAttribute::_owner, PsOutput< Type >::getAlias(), PsSimulatedObject::getName(), and PsOutput< Type >::getUsedOutput(). { /* thread safety assessement : const method : thread safe. shown value may not be a coherant image of an PsOutput */ err << "**********************************************************" << endl; err << "Class PsOutput" << endl; err << "Owner : " << _owner.getName () << endl; err << "Output Name : "<< _name <<endl; err << "Type of output : "<< typeid(Type).name() << endl ; err << "Output primary alias : " << getAlias() << endl ; err << "Used Output : " << getUsedOutput () << endl ; err << "History Fifo: "<<_history <<endl;

template<typename Type> void PsOutput< Type >::printHistory (    )  const [inline]

print all the stored values Definition at line 784 of file PsOutput.h. References PsOutput< Type >::_history. { /* thread safety assessement : const method : should be thread safe if printDebuggingInformation of PsnAbstractFifo is thread safe */ _history->printDebuggingInformation () ;

template<typename Type> void PsOutput< Type >::set (  const Type &    newValue )  [inline, virtual]

publish a new value through this output Parameters: newValue  the new value of this output Reimplemented in PsMomeOutput< Type >. Definition at line 596 of file PsOutput.h. References PsOutput< Type >::_date, PsOutput< Type >::_history, PsAttribute::_owner, PsSimulatedObject::getController(), PsnCurrentActiveObject::getCurrentActiveObject(), PsOutput< Type >::notifyConnectedSensitiveInputs(), and PsOutput< Type >::setValidity(). Referenced by PsMomeOutput< Type >::set(). { assert (&_owner == PsnCurrentActiveObject::getCurrentActiveObject() || PsnCurrentActiveObject::getCurrentActiveObject() == & _owner.getController() || PsnCurrentActiveObject::getCurrentActiveObject() == NULL ) ; /* thread safety assessement : localGet and set could collide. Thread safety can only be assured if the fifo and the interpolator are thread safe with respect to the value in the fifo. only one set at a time. */ if (_validity) { const Type & oldValue = _history->getPreceedingValue(0); if( newValue != oldValue ) //comparaison has to be done before the set, because we're working on references and that there can be a double set (bug corrected by D. Margery) { _history->set ( newValue, _date) ; notifyConnectedSensitiveInputs() ; } else { _history->set ( newValue, _date) ; } } else { _history->set (newValue, _date) ; setValidity(true) ; notifyConnectedSensitiveInputs(); }

template<typename Type> void PsOutput< Type >::setAlias (  PsOutputAlias< Type > *    output )  [inline, virtual]

set the direct alias of this output Definition at line 403 of file PsOutput.h. References PsOutput< Type >::_aliasOfOutput. Referenced by PsOutputAlias< Type >::alias(), and PsOutputAlias< Type >::PsOutputAlias(). { /* thread safety assessement : multiple simultaneous access possible, but they don't compromise thread safety : last one out wins */ _aliasOfOutput = output ;

template<typename Type> void PsOutput< Type >::setInPlace (  const Type &    )  [inline, virtual]

zero copy set for values wich have been calculated using the reference obtained by getNextPlaceHolder Definition at line 869 of file PsOutput.h. References PsOutput< Type >::_date, PsOutput< Type >::_history, PsOutput< Type >::notifyConnectedSensitiveInputs(), and PsOutput< Type >::setValidity(). { if (_validity) { const Type & oldValue = _history->getPreceedingValue(0); if( newValue != oldValue) //comparaison has to be done before setInPlace, because there can be a double setInPlace and we're working on references (bug corrected by D. Margery) { _history->setInPlace ( newValue, _date ) ; notifyConnectedSensitiveInputs(); } else { _history->setInPlace ( newValue, _date ) ; } } else { _history->setInPlace ( newValue, _date) ; setValidity(true) ; notifyConnectedSensitiveInputs(); }

template<class Type> void PsOutput< Type >::setUsedOutput (  PsOutput< Type > *    output )  [inline, virtual]

change the output read by internal get Reimplemented in PsMomeOutput< Type >, and PsOutputAlias< Type >. Definition at line 367 of file PsOutput.h. References PsOutput< Type >::_usedOutput. Referenced by PsOutputAlias< Type >::alias(), PsOutputAlias< Type >::PsOutputAlias(), PsOutputAlias< Type >::setUsedOutput(), PsMomeOutput< Type >::setUsedOutput(), and PsOutput< Type >::unsetAlias(). { /* thread safety assessement : multiple simultaneous access possible, and doesn't compromise thread safety : last one out wins */ _usedOutput = output ;

template<typename Type> void PsOutput< Type >::setValidity (  bool    )  [protected, virtual]

setValidity. change the validity of the output Reimplemented in PsMomeOutput< Type >. Definition at line 379 of file PsOutput.h. References PsOutput< Type >::_validity. Referenced by PsOutput< Type >::empty(), PsOutput< Type >::extract(), PsOutput< Type >::set(), PsOutput< Type >::setInPlace(), PsMomeOutput< Type >::setValidity(), PsOutput< Type >::suggest(), PsOutput< Type >::unpack(), and PsOutput< Type >::unpackAllValues(). { /* thread safety assessement : protected method, used to change protected member : thread safety should be insured by callers */ _validity = b ;

template<typename Type> void PsOutput< Type >::suggest (  const Type &    suggestedValue )  [inline, virtual]

used by an input to suggest an initial value if none has yet been produced Parameters: suggestedValue  the suggested initial value for this output Definition at line 896 of file PsOutput.h. References PsOutput< Type >::_history, PsAttribute::_owner, PsOutput< Type >::_validity, PsSimulatedObject::getController(), PsController::getSimulatedDate(), PsOutput< Type >::notifyConnectedSensitiveInputs(), and PsOutput< Type >::setValidity(). { if (!_validity) { _history->set ( newValue , _owner.getController ().getSimulatedDate () ) ; setValidity(true) ; notifyConnectedSensitiveInputs(); }

template<typename Type> void PsOutput< Type >::unpack (  PsIncomingSynchronisationMessage &    )  [virtual]

unpack value from a PvmMessage ( should be delegated to a pvm output ) shouldn't unpack the name, but all other usefull information packed Reimplemented from PsFlowable. Definition at line 700 of file PsOutput.h. References PsOutput< Type >::_history, PsOutput< Type >::notifyConnectedSensitiveInputs(), and PsOutput< Type >::setValidity(). { // shouldn't unpack the name, but all other usefull information packed /* thread safety assessement : localGet and extract could collide. Thread safety can only be assured if the fifo and the interpolator are thread safe with respect to the values in the fifo. only one extract at a time. */ if (_validity) { const Type & oldValue = _history->getPreceedingValue(0); _history->unpack ( in ) ; if(_history->getPreceedingValue(0) != oldValue) //double extract won't happen { notifyConnectedSensitiveInputs(); } } else { _history->unpack ( in ) ; setValidity(true) ; notifyConnectedSensitiveInputs() ; }

template<typename Type> void PsOutput< Type >::unpackAllValues (  PsIncomingSynchronisationMessage &    )  [virtual]

unpack value from a PvmMessage ( should be delegated to a pvm output ) shouldn't unpack the name, but all other usefull information packed Implements PsOutputNT. Definition at line 728 of file PsOutput.h. References PsOutput< Type >::_history, PsOutput< Type >::notifyConnectedSensitiveInputs(), and PsOutput< Type >::setValidity(). { // shouldn't unpack the name, but all other usefull information packed /* thread safety assessement : localGet and extract could collide. Thread safety can only be assured if the fifo and the interpolator are thread safe with respect to the values in the fifo. only one extract at a time. */ if (_validity) { // only in the case a suggested values was given at connection const Type & oldValue = _history->getPreceedingValue(0); _history->unpackAllValues ( in ) ; if(_history->getPreceedingValue(0) != oldValue) //double extract won't happen { notifyConnectedSensitiveInputs(); } } else { _history->unpackAllValues ( in ) ; setValidity(true) ; }

template<typename Type> void PsOutput< Type >::unsetAlias (    )  [inline, virtual]

cancel aliasing Reimplemented in PsOutputAlias< Type >. Definition at line 390 of file PsOutput.h. References PsOutput< Type >::_aliasOfOutput, and PsOutput< Type >::setUsedOutput(). Referenced by PsOutputAlias< Type >::unsetAlias(). { /* thread safety assessement : multiple simultaneous access possible, but they don't compromise thread safety : last one out wins */ _aliasOfOutput = NULL ; setUsedOutput ( this ) ;

---

Friends And Related Function Documentation

template<typename Type> friend class PsOutputAlias< Type > [friend]

friend declaration so thah aliases can notify the sensitive inputs connected to their aliased output Definition at line 204 of file PsOutput.h.

---

Member Data Documentation

template<typename Type> PsOutputAlias<Type>* PsOutput< Type >::_aliasOfOutput [protected]

a pointer to the primary alias of this output Definition at line 220 of file PsOutput.h. Referenced by PsOutput< Type >::getAlias(), PsOutput< Type >::setAlias(), PsOutput< Type >::unsetAlias(), and PsOutput< Type >::~PsOutput().

template<typename Type> const PsDate& PsOutput< Type >::_date [protected]

a reference to the current date Definition at line 229 of file PsOutput.h. Referenced by PsOutput< Type >::set(), and PsOutput< Type >::setInPlace().

template<typename Type> PsnAbstractFifo<Type>* PsOutput< Type >::_history [protected]

the history storing fifo Definition at line 226 of file PsOutput.h. Referenced by PsOutput< Type >::empty(), PsOutput< Type >::extract(), PsOutput< Type >::get(), PsMomeOutput< Type >::get(), PsOutput< Type >::getDateOfLastExactValue(), PsNullOutput< Type >::getDateOfLastExactValue(), PsOutput< Type >::getLastExactValue(), PsNullOutput< Type >::getLastExactValue(), PsOutput< Type >::getNextPlaceHolder(), PsOutput< Type >::localInsert(), PsOutput< Type >::pack(), PsOutput< Type >::packAllValues(), PsOutput< Type >::printDebuggingInformation(), PsOutput< Type >::printHistory(), PsMomeOutput< Type >::PsMomeOutput(), PsOutput< Type >::PsOutput(), PsOutput< Type >::set(), PsOutput< Type >::setInPlace(), PsOutput< Type >::suggest(), PsOutput< Type >::unpack(), PsOutput< Type >::unpackAllValues(), PsMomeOutput< Type >::~PsMomeOutput(), and PsOutput< Type >::~PsOutput().

template<typename Type> list<PsSensitiveInput <Type> *> PsOutput< Type >::_listOfConnectedSensitiveInputs [protected]

the list of connected sensitive inputs Definition at line 237 of file PsOutput.h. Referenced by PsOutput< Type >::connectedMyself(), PsOutput< Type >::disconnectedMyself(), PsOutput< Type >::notifyConnectedSensitiveInputs(), and PsOutput< Type >::~PsOutput().

template<typename Type> list<PsInput <Type> *> PsOutput< Type >::_listOfConnectedUnsensitiveInputs [protected]

the list of connected unsensitive inputs Definition at line 240 of file PsOutput.h. Referenced by PsOutput< Type >::connectedMyself(), PsOutput< Type >::disconnectedMyself(), and PsOutput< Type >::~PsOutput().

template<typename Type> PsnMutexLock PsOutput< Type >::_myMutex [protected]

A mutual exclusion lock to protect local data from corruption in a multithreaded environment Need to be protected : _listOfConnectedSensitiveInputs, outputAsc. Definition at line 248 of file PsOutput.h. Referenced by PsOutput< Type >::connectedMyself(), PsOutput< Type >::disconnectedMyself(), PsOutput< Type >::notifyConnectedSensitiveInputs(), and PsOutput< Type >::~PsOutput().

template<typename Type> PsPolator<Type>* PsOutput< Type >::_polator

the associated polator Definition at line 233 of file PsOutput.h. Referenced by PsOutput< Type >::localGet(), PsMomeOutput< Type >::PsMomeOutput(), and PsOutput< Type >::PsOutput().

template<typename Type> bool PsOutput< Type >::_sensitiveInputsConnected [protected]

a boolean indicating is sensible inputs are connected Definition at line 243 of file PsOutput.h. Referenced by PsOutput< Type >::connectedMyself(), and PsOutput< Type >::disconnectedMyself().

template<typename Type> PsOutput<Type>* PsOutput< Type >::_usedOutput [protected]

the output read by get Definition at line 223 of file PsOutput.h. Referenced by PsOutput< Type >::getUsedOutput(), PsOutput< Type >::PsOutput(), and PsOutput< Type >::setUsedOutput().

template<typename Type> bool PsOutput< Type >::_validity [protected]

a boolean indicating presence of values in the fifo Definition at line 251 of file PsOutput.h. Referenced by PsMomeOutput< Type >::extract(), PsMomeOutput< Type >::get(), PsOutput< Type >::localGet(), PsOutput< Type >::localInsert(), PsOutput< Type >::setValidity(), and PsOutput< Type >::suggest().

---

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

• PsOutput.h

---