OMK::PvmReferenceObjectHandle Class Reference

Defines an reference object handle for pvm controllers. More...

#include <OMKPvmReferenceObjectHandle.h>

Inheritance diagram for OMK::PvmReferenceObjectHandle:

[legend]Collaboration diagram for OMK::PvmReferenceObjectHandle:

[legend]List of all members.

Public Member Functions
	PvmReferenceObjectHandle (SimulatedObject &object, Controller &controller)
	contructor
	PvmReferenceObjectHandle (SimulatedObject &object, Controller &controller, SignalDispatcher *signalDispatcher)
	Constructor using a allready initialised signal dispatcher.
virtual	~PvmReferenceObjectHandle ()
	destructor
virtual void	emettreValAttributs (PvmOutgoingMessage *messFD, PvmOutgoingMessage *messEV)
	emission initiale des valeurs d'attribut vers un nouveau miroir abonne
virtual void	insertInStream (std::ostream &=std::cout) const
	insert synchronisation management data for mirrorObjectHandles in output stream
virtual void	extract (std::istream &=std::cin)
	extract synchronisation management data from mirrorObjectHandle from input stream
virtual void	unpack (IncomingSynchronisationMessage &)
	unpack from a synchronisation message
virtual void	makeSynchronisationMessage (const Date &date)
	On stocke dans le canal le message a envoyer.
virtual void	packInitialValues (PvmOutgoingMessage &message)
virtual void	setMorphosisPhaseTrue ()
	CHADI.
virtual void	flushDisconnectedSitesOutgoingBuffer ()
	CHADI.
Static Protected Member Functions
static int	plusPetitSSMultSup (const int A, const int B)
	Calcul du plus petit ss-multiple de A > B.
Protected Attributes
std::map< Name, SvmLink * >	_needUpdateOutputValues
bool	morphosisPhase
	CHADI.
std::map< Name, SvmLink * >	_needAllOutputValues
	the list of processes that need a complete message (versus just an update if the simulated object has been activated and the outputs have changed) during the next syncronisation message

---

Detailed Description

Defines an reference object handle for pvm controllers.

Author:

David Margery (based on code previously in ReferenceObjectHandle by Siames)

Version:

1.4

• 1.0 -> 1.1 by David Margery ( 2002/08/08): separated the synchronisation messages between update messages and complete messages
• 1.1 -> 1.2 by David Margery (2002/08/09): implemented unregistration
• 1.2 -> 1.3 by David Margery (2002/09/04): added a packInitialValues member function
• 1.3 -> 1.4 by Chadi Zammar (2005/01): added the methods flushDisconnectedSitesOutgoingBuffer and setMorphosisPhaseTrue

Definition at line 44 of file OMKPvmReferenceObjectHandle.h.

---

Constructor & Destructor Documentation

PvmReferenceObjectHandle::PvmReferenceObjectHandle	(	SimulatedObject &	object,
		Controller &	controller
	)

contructor

Definition at line 39 of file OMKPvmReferenceObjectHandle.cxx.

  : ReferenceObjectHandle ( object, controller),
    morphosisPhase ( false )
{
}

PvmReferenceObjectHandle::PvmReferenceObjectHandle	(	SimulatedObject &	object,
		Controller &	controller,
		SignalDispatcher *	signalDispatcher
	)

Constructor using a allready initialised signal dispatcher.

Parameters:

	object	the encapsulated object
	controller	the encapuslating controller
	signalDispatcher	the signal dispatcher to use : responsability of destruction is handled to that object

Definition at line 47 of file OMKPvmReferenceObjectHandle.cxx.

  : ReferenceObjectHandle ( object, controller, signalDispatcher),
    morphosisPhase ( false )
{
}

PvmReferenceObjectHandle::~PvmReferenceObjectHandle

(

)

[virtual]

destructor

Definition at line 58 of file OMKPvmReferenceObjectHandle.cxx.

{
}

---

Member Function Documentation

void PvmReferenceObjectHandle::emettreValAttributs	(	PvmOutgoingMessage *	messFD,
		PvmOutgoingMessage *	messEV
	)			[virtual]

emission initiale des valeurs d'attribut vers un nouveau miroir abonne

Definition at line 65 of file OMKPvmReferenceObjectHandle.cxx.

{

}

void PvmReferenceObjectHandle::insertInStream

(

std::ostream &

= std::cout

)

const [virtual]

insert synchronisation management data for mirrorObjectHandles in output stream

Reimplemented from OMK::ReferenceObjectHandle.

Definition at line 72 of file OMKPvmReferenceObjectHandle.cxx.

References OMK::Controller::error().

{
  Controller::error ("On utilise l'insert du referentiel") ;
}

void PvmReferenceObjectHandle::extract

(

std::istream &

= std::cin

)

[virtual]

extract synchronisation management data from mirrorObjectHandle from input stream

Reimplemented from OMK::ReferenceObjectHandle.

Definition at line 218 of file OMKPvmReferenceObjectHandle.cxx.

References OMK::ReferenceObjectHandle::_controller, _needAllOutputValues, OMK::CancelRegistration, OMK::EventReceived, OMK::ReferenceObjectHandle::receiveRegistrationForSignal(), OMK::RegisterForSignal, and OMK::Registration.

{
#if defined (_DEBUGPVMMESS)
  cerr << "PvmReferenceObjectHandle::extract:"<<endl;
#endif
  // Type de message
  std::string typeMess ;
  // Nom du processus ou se trouve le miroir (cas de l'EV)
  Name processName ;

  in >> typeMess ;
  //cerr << "PvmReferenceObjectHandle::extract: received a message of type " <<typeMess<<endl;
  if( typeMess == "EV" ) 
  {
    int typeEv ;
    in >> typeEv ;
    cerr << "PvmReferenceObjectHandle::extract: received an event message of type " <<typeEv<<endl;
    if (typeEv == Registration) 
    {
      // Frequency max des refs du pss distant
      Frequency freqOMKsDist ;
      // Frequency de ce pss
      Frequency freqLocale ;
      // Frequency de communication
      Frequency  freqComm ;

      // On recupere le nom du processus associe
      in >> processName ;
#ifdef _DEBUGPVMMESS
      cout << "PvmReferenceObjectHandle::extract "<<processName << " registred a mirror "<< endl ;
#endif
      // On recupere le processus associe
      SvmLink * canal = dynamic_cast<PvmController &>(_controller).getDistributedVirtualMachine()->getLinkToProcessNamed (processName) ;

      Process * processDescriptor = dynamic_cast<PvmController &>(_controller).getDistributedVirtualMachine()->getProcessDescriptorNamed (processName) ;

      //the registering process needs a complete version of the outputs of the object in the next synchronisation message
      _needAllOutputValues.insert ( make_pair (processName,canal) ) ;

      //            // On recupere la frequency max des refs du pss distant
      //            freqOMKsDist = processDescriptor->getMaxFrequencyOfHostedObjects () ;
      //            // On recupere la frequency locale
      //            freqLocale = _myObject. getObjectDescriptor ().getFrequency () ;
      //            // On calcule la frequency de communication
      //  #ifdef _DEBUGPVMMESS
      //            cout << "freqLocale : " << freqLocale << endl ;
      //            cout << "freqOMKsDist : " << freqOMKsDist << endl ;
      //  #endif
      //            if (freqLocale > freqOMKsDist) {
      //               freqComm = plusPetitSSMultSup(freqLocale,
      //                                              freqOMKsDist) ;
      //  #ifdef _DEBUGPVMMESS
      //               cout << "freqComm : " << freqComm << endl ;
      //  #endif
      //            } else {
      //            freqComm = freqLocale ;
      //  #ifdef _DEBUGPVMMESS
      //            cout << "freqComm  : " << freqComm << endl ;
      //  #endif
      //            }
      //         // On la stocke
      //            _processFrequencies.insert(ProcessFrequenciesType::value_type(processName, freqComm)) ;
    } 
    else if (typeEv == CancelRegistration) {
      //cout << "On se desabonne" << endl ;
    } 
    else if (typeEv == EventReceived) {
      //#ifdef DEBUG
      cerr << "ALERTE PvmReferenceObjectHandle::extract : On recoit un evenement en provenance d'un miroir" << endl ;
      //#endif
      assert ( false ) ;
      //Event evt ( in ) ;
      //in >> evt ;
      //receiveReallyEvent (evt) ;
    } 
    else if (typeEv == RegisterForSignal) 
    {
#ifdef DEBUG
      cout << "On recoit un signal en provenance d'un miroir" << endl ;
#endif
      Name sigId ;
      Name abonne ;
      Name eventId ;
      in >> sigId >> abonne >> eventId ;
      receiveRegistrationForSignal (sigId, abonne, eventId );
    } 
    else {
      cerr<<"PvmReferenceObjectHandle::extract : Type d'evenement incorrect"<<endl ;
    }
  }
  else {
    cerr<<"PvmReferenceObjectHandle::extract : Type d'evenement incorrect" <<endl ;
  }
}

void PvmReferenceObjectHandle::unpack

(

IncomingSynchronisationMessage &

)

[virtual]

unpack from a synchronisation message

Reimplemented from OMK::Flowable.

Definition at line 78 of file OMKPvmReferenceObjectHandle.cxx.

References OMK::ReferenceObjectHandle::_controller, OMK::ObjectHandle::_myObject, _needAllOutputValues, _needUpdateOutputValues, OMK::CancelRegistration, OMK::ReferenceObjectHandle::cancelRegistrationForSignal(), OMK::CancelRegistrationForSignal, OMK::EventCreator::createEvent(), OMK::EventReceived, OMK::SimulatedObject::getSimulatedDate(), OMK::ObjectHandle::getSimulatedObject(), OMTRACEID, OMK::ReferenceObjectHandle::receiveEvent(), OMK::ReferenceObjectHandle::receiveRegistrationForSignal(), OMK::RegisterForSignal, OMK::Registration, OMK::SimulatedObject::unpack(), OMK::Event::unpack(), and OMK::Name::unpack().

{
#if defined (_DEBUGPVMMESS)
  cerr << "PvmReferenceObjectHandle::unpack"<<endl;
#endif
  // Frequency max des refs du pss distant
  Frequency freqOMKsDist ;
  // Frequency de ce pss
  Frequency freqLocale ;
  // Frequency de communication
  Frequency  freqComm ;

  RequestType typeMess ;
  int messageType ;

  in >> messageType ;
  typeMess = static_cast <RequestType> (messageType) ;

#if defined (_DEBUGPVMMESS)
  cerr << "PvmReferenceObjectHandle::unpack: received a message of type " 
       <<typeMess<<" "<<Registration
       <<" at date "<<getSimulatedObject().getSimulatedDate()
       <<endl;
#endif
 
  if (typeMess == Registration) 
    {
      // name of the process sending the message
      Name processName ;
         
      processName.unpack ( in ) ;

#ifdef _DEBUGPVMMESS
      cout << "PvmReferenceObjectHandle::unpack " << processName << " registering a mirror "<< endl ;
#endif
      SvmLink * canal = dynamic_cast<PvmController &>(_controller).getDistributedVirtualMachine()->getLinkToProcessNamed (processName) ;

      Process * processDescriptor = dynamic_cast<PvmController &>(_controller).getDistributedVirtualMachine()->getProcessDescriptorNamed (processName) ;
         
      //the registering process needs a complete version of the outputs of the object in the next synchronisation message
      _needAllOutputValues.insert ( make_pair(processName, canal) ) ;

      //         // On recupere la frequency max des refs du pss distant
      //         freqOMKsDist = processDescriptor->getMaxFrequencyOfHostedObjects () ;
      //         // On recupere la frequency locale
      //         freqLocale = _myObject. getObjectDescriptor ().getFrequency () ;
      //         // On calcule la frequency de communication
      //  #ifdef _DEBUGPVMMESS
      //         cout << "freqLocale : " << freqLocale << endl ;
      //         cout << "freqOMKsDist : " << freqOMKsDist << endl ;
      //  #endif
      //         if (freqLocale > freqOMKsDist) 
      //            {
      //               freqComm = plusPetitSSMultSup(freqLocale,
      //                                              freqOMKsDist) ;
      //  #ifdef _DEBUGPVMMESS
      //               cout << "freqComm : " << freqComm << endl ;
      //  #endif
      //            } 
      //         else 
      //            {
      //               freqComm = freqLocale ;
      //  #ifdef _DEBUGPVMMESS
      //               cout << "freqComm  : " << freqComm << endl ;
      //  #endif
      //            }
      //         // On la stocke
      //         _processFrequencies.insert (ProcessFrequenciesType::value_type(processName, freqComm)) ;
    } 
  else if (typeMess == CancelRegistration) 
    {
     OMTRACEID("DEBUGPVM", "Cancel : " << "avant unpack"); 
      // name of the process sending the message
      Name processName ;
      processName.unpack ( in ) ;
      OMTRACEID("DEBUGPVM", "Cancel : " << "avant ProcessName is" << processName); 

      _needUpdateOutputValues.erase (processName) ; 
      //_processFrequencies.erase ( processName ) ;
      _needAllOutputValues.erase ( processName ) ;
    } 
  else if (typeMess == EventReceived) 
    {
#if ( defined (_DEBUGPVMMESS) || defined (_DEBUGPVMEVENTS ) )
      cerr << "PvmReferenceObjectHandle::unpack: received an event relayed from an mirror" << endl ;
#endif
      Event * event ;
      Name classToCreate ;
      EventIdentifier eventId;
      Date eventDate;
      Name sender, receiver ;
      in >> classToCreate >> eventId>> eventDate>>sender>>receiver ;
      event = EventCreator::createEvent (classToCreate, eventId, eventDate, sender, receiver ) ;
      event->unpack ( in ) ;
      ReferenceObjectHandle::receiveEvent ( event ) ;
    } 
  else if (typeMess == RegisterForSignal) 
    {
#ifdef _DEBUGPVMMESS
      cout << "PvmReferenceObjectHandle::unpack: RegisterForSignal" << endl ;
#endif
      Name sigId ;
      Name registrant ;
      Name eventId ;
      in >> sigId >> registrant >> eventId ;
      receiveRegistrationForSignal (sigId, registrant, eventId );
    } 
  else if (typeMess == CancelRegistrationForSignal) 
    {
#ifdef _DEBUGPVMMESS
      cout << "PvmReferenceObjectHandle::unpack: CancelRegistrationForSignal" << endl ;
#endif
      Name sigId ;
      Name registrant ;
      in >> sigId >> registrant ;
      cancelRegistrationForSignal (sigId, registrant) ;
    }
  else if (typeMess == SynchronisationMessage) // ajout TDTD pour essayer de voir ce qui ne va pas...
    {
       //if (morphosisPhase) { // TDTD il me semble pourtant que ce serait bien...
       //cerr<<"PvmReferenceObjectHandle::unpack : TDTD : SynchronisationMessage for" << getSimulatedObject ().getName () <<endl; ;
          _myObject.unpack ( in ) ;
          // semble poser des pbs pour la suppression d'objets locaux...
          //_myObject.unpackAllValues ( in ) ;
          //}
    }
  else 
    {
      cerr<<"PvmReferenceObjectHandle::unpack : unknown request"<<typeMess<<endl; ;
      cerr << "messageType : " << messageType << endl ;
          assert( false && "You should not be there..." ) ;
    }

#if defined (_DEBUGPVMMESS)
  cerr << "PvmReferenceObjectHandle::unpack finished"<<typeMess <<endl;
#endif
}

void PvmReferenceObjectHandle::makeSynchronisationMessage

(

const Date &

date

)

[virtual]

On stocke dans le canal le message a envoyer.

CHADI

END CHADI

CHADI

END CHADI

Definition at line 317 of file OMKPvmReferenceObjectHandle.cxx.

References OMK::ReferenceObjectHandle::_dateOfLastActivation, OMK::ObjectHandle::_myObject, _needAllOutputValues, _needUpdateOutputValues, OMK::SimulatedObject::getName(), OMK::ObjectHandle::getSimulatedObject(), morphosisPhase, and packInitialValues().

Referenced by OMK::PvmController::makeSynchronisationMessage().

{
  if (!morphosisPhase)
  {
#if defined (_DEBUGEXECPVM) || defined (_DEBUGPVMMESS) 
    cerr<<"PvmReferenceObjectHandle::makeSynchronisationMessage ( const Date & "<<date<< ")"<<endl;
#endif
    PvmOutgoingMessage * message ;

    if ( _dateOfLastActivation == date )
      // only send a synchronisation message if the handled object has been activated
    {
      NameToPointerMap<SvmLink>::iterator pCanal ; // iterateur
      //         ProcessFrequenciesType::iterator pFreq ; // iterateur
      //         Date dtComm ;
      //         Frequency freqComm ;
#ifdef _DEBUGPVMMESS
      cout<<"makeSynchronisationMessages of "<<getSimulatedObject().getName()<<endl;
#endif
      // On initialise l'iterateur sur la frequency
      //pFreq = _processFrequencies.begin () ;
      //Pour tous les abonnes
      for (pCanal = _needUpdateOutputValues.begin () ;
        pCanal != _needUpdateOutputValues.end ();
        pCanal ++) 
      {
        // On calcule le pas de temps de la communication
        //             freqComm = (*pFreq).second ;
        //             dtComm = 1000 / freqComm ;
#ifdef _DEBUGPVMMESS
        //             cout << "dtComm : " << dtComm << endl ;
#endif
        // On verifie qu'il faut reellement emettre
        // devrait maintenant etre inutile a cause des Frames majeures et mineures
        //             if (_controller.getSimulatedDate () % dtComm == 0) 
        //                {
        // On recupere le message ou stocker les donnees
        message = &(*pCanal).second->getOutgoingBuffer () ;  
#ifdef _DEBUGPVMMESS
        cout <<"PvmReferenceObjectHandle::makeSynchronisationMessage writing to the buffer: " <<message<< endl ;
#endif
        // On va construire le message
        // On ajoute le destinataire, puis le type du message puis les outputs
        *message << _myObject.getName ()  
          << static_cast<int> (SynchronisationMessage) 
          <<  _myObject ;

#ifdef _DEBUGDISTRIBUTEDINIT
        std::cerr<<"PvmReferenceObjectHandle::makeSynchronisationMessage : sending a message to ";
        (*pCanal).second->printDebuggingInformation();
#endif
      }
      // On passe a la frequency suivante
      //        pFreq ++ ;
      //        }
    }
    else
    {
#ifdef _DEBUGPVMMESS
      cerr <<"PvmReferenceObjectHandle::makeSynchronisationMessage : No synchronisation needed at " 
        << date 
        <<", last activation : "<<_dateOfLastActivation<<endl ;
#endif
    }
    // send complete values to the processes needing a complete list of the values with their associated production date.
    // this is done after updating, because processes in that list are then automatically inserted in the list of process needing only updates
    for (std::map<Name, SvmLink *>::iterator i = _needAllOutputValues.begin() ;
      i != _needAllOutputValues.end() ;
      ++i)
    {
      packInitialValues ( (i->second)->getOutgoingBuffer () ) ; 

      _needUpdateOutputValues.insert ( *i ) ;
    }
    _needAllOutputValues.clear() ;
#ifdef _DEBUGPVMMESS
    cerr <<"PvmReferenceObjectHandle::makeSynchronisationMessage end" <<endl ;
#endif 

  }
}

void PvmReferenceObjectHandle::packInitialValues

(

PvmOutgoingMessage &

message

)

[virtual]

Definition at line 440 of file OMKPvmReferenceObjectHandle.cxx.

References OMK::ObjectHandle::_myObject, OMK::SimulatedObject::getName(), OMK::InitialValuesMessage, OMK::Name::pack(), and OMK::SimulatedObject::packAllValues().

Referenced by makeSynchronisationMessage(), and OMK::PvmController::sendInitialValuesToMirror().

{
  _myObject.getName ().pack ( message ) ; 
  message << static_cast<int> (InitialValuesMessage) ;
  _myObject.packAllValues ( message ) ;
}

void PvmReferenceObjectHandle::setMorphosisPhaseTrue

(

)

[virtual]

CHADI.

Reimplemented from OMK::ReferenceObjectHandle.

Definition at line 461 of file OMKPvmReferenceObjectHandle.cxx.

References morphosisPhase.

{
  morphosisPhase = true ;
}

void PvmReferenceObjectHandle::flushDisconnectedSitesOutgoingBuffer

(

)

[virtual]

CHADI.

Definition at line 449 of file OMKPvmReferenceObjectHandle.cxx.

References _needUpdateOutputValues.

{

  NameToPointerMap<SvmLink>::iterator pCanal ;
  for (pCanal = _needUpdateOutputValues.begin () ;
    pCanal != _needUpdateOutputValues.end ();
    pCanal ++) 
  {
    (*pCanal).second->getOutgoingBuffer().flushCurrentBuffer() ;  
  }
}

int PvmReferenceObjectHandle::plusPetitSSMultSup	(	const int	A,
		const int	B
	)			[static, protected]

Calcul du plus petit ss-multiple de A > B.

Definition at line 404 of file OMKPvmReferenceObjectHandle.cxx.

                                                                          {
  // Fournit le plus petit sous-multiple de A plus grand que B
  int i = B ; // Valeur testee
  // Valeur max au dela de laquelle pas ss-multiple
  int valMax = div (A, 2).quot ; 
  bool ssMult = false ; // i ss-multiple de A ???

#ifdef DEBUG
  cout << "plusPetitSSMultSup***************************************" << endl ;
  cout << "A : " << A << ", B : " << B << endl ;
  cout << "valMax : " << valMax << endl ;
#endif

  // On verifie si i ss-multiple de A
  ssMult = (div (A, i).rem == 0) ;
  while ((! ssMult) && (i <= valMax)) {
    i++ ;
    // On verifie si i ss-multiple de A
    ssMult = (div (A, i).rem == 0) ;
  }
  if (i > valMax) {
#ifdef DEBUG
    cout << "res : " << A << endl ;
    cout << "Fin de plusPetitSSMultSup***************************************" << endl;
#endif  
    return A ;
  } else {
#ifdef DEBUG
    cout << "res : " << i << endl ;
    cout << "Fin de plusPetitSSMultSup***************************************" << endl;
#endif  
    return i ;
  }
}

---

Member Data Documentation

std::map<Name, SvmLink *> OMK::PvmReferenceObjectHandle::_needUpdateOutputValues [protected]

Definition at line 84 of file OMKPvmReferenceObjectHandle.h.

Referenced by flushDisconnectedSitesOutgoingBuffer(), makeSynchronisationMessage(), and unpack().

bool OMK::PvmReferenceObjectHandle::morphosisPhase [protected]

CHADI.

Definition at line 87 of file OMKPvmReferenceObjectHandle.h.

Referenced by makeSynchronisationMessage(), and setMorphosisPhaseTrue().

std::map<Name, SvmLink *> OMK::PvmReferenceObjectHandle::_needAllOutputValues [protected]

the list of processes that need a complete message (versus just an update if the simulated object has been activated and the outputs have changed) during the next syncronisation message

Definition at line 96 of file OMKPvmReferenceObjectHandle.h.

Referenced by extract(), makeSynchronisationMessage(), and unpack().

---