---

PsValuedEvent.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 PsValuedEventHEADER
#define PsValuedEventHEADER

#include "PsEvent.h"
#include "PsnEventAssociationList.h"
#include "PsEventCreator.h"

template <typename UserType >
class PsValuedEvent : public PsEvent {
public:

   UserType value ; 
   
   PsValuedEvent(const PsValuedEvent & originalEvent);
   
   PsValuedEvent & operator = (const PsValuedEvent & originalEvent);
   

   virtual PsValuedEvent * clone () const ;

   
   virtual void insertInStream (ostream & = cout) const;

   
   virtual void extract (istream & = cin);
      


   virtual void unpack (PsIncomingSynchronisationMessage &) ;



   virtual void pack (PsOutgoingSynchronisationMessage &) const ;




   PsValuedEvent(const PsEventIdentifier & event, const PsDate & date, const PsName & sender, const PsName & receiver, const UserType & userValue );
   
   PsValuedEvent(const PsEventIdentifier & event, const PsDate & date, const PsName & sender, const PsName & receiver) ;

   
   virtual ~PsValuedEvent();
  
protected:
   class ValuedEventCreator : public PsEventCreator
   {
   public:
      virtual ~ValuedEventCreator() 
      {
      } 
      

      ValuedEventCreator () : PsEventCreator ( typeid( PsValuedEvent<UserType> ).name() ) 
      {
      }
   protected:
      virtual PsEvent * createRealEvent (const PsEventIdentifier & event, const PsDate & date, const PsName & sender, const PsName & receiver )
      {
         return new PsValuedEvent<UserType> (event, date, sender, receiver) ;
      }      
   };
public:
   static ValuedEventCreator myEventCreator ;

};



//------------------------ implementation -------------------------
template <typename UserType>
typename PsValuedEvent<UserType>::ValuedEventCreator PsValuedEvent<UserType>::myEventCreator ;



template <typename UserType>
PsValuedEvent<UserType>::PsValuedEvent(const PsValuedEvent<UserType> & originalEvent) :
   PsEvent ( originalEvent ),
   value ( originalEvent.value )
{
   // this static ensures that the static members are present in the genretaed code
   // enabling correct linking. In this case, it enbles valued event registration with the PsEventCreator
  static bool instanciated = myEventCreator.touch() ;
}



template <typename UserType>
PsValuedEvent<UserType> & PsValuedEvent<UserType>::operator = (const PsValuedEvent<UserType> & originalEvent) 
{
   PsEvent::operator = ( originalEvent ) ;
   value = originalEvent.value ;
}



template <typename UserType>
PsValuedEvent<UserType> * PsValuedEvent<UserType>::clone () const {
   return new PsValuedEvent<UserType>( *this ) ;
}



template <typename UserType>
void PsValuedEvent<UserType>::insertInStream(ostream & out) const {
   PsEvent::insertInStream ( out ) ;
   out<<value<<" ";
}

template <typename UserType>
void PsValuedEvent<UserType>::extract ( istream & in ) {
   PsEvent::extract ( in ) ;
   in >> value ;
}

template <typename UserType>
PsValuedEvent<UserType>::PsValuedEvent(const PsEventIdentifier & event, 
                                       const PsDate & date, 
                                       const PsName & sender, 
                                       const PsName & receiver, 
                                       const UserType & userValue ) :
   PsEvent(event, date, sender, receiver) ,
   value (userValue )
{
   // this static ensures that the static members are present in the generated code
   // enabling correct linking. In this case, it enbles valued event registration with the PsEventCreator
   // as from g++3, it is no longer necessary in constructors
  static bool instanciated = myEventCreator.touch() ;
}



template <typename UserType>
PsValuedEvent<UserType>::PsValuedEvent(const PsEventIdentifier & event, 
                                       const PsDate & date, 
                                       const PsName & sender, 
                                       const PsName & receiver ) :
   PsEvent(event, date, sender, receiver) 
{
   // this static ensures that the static members are present in the generated code
   // enabling correct linking. In this case, it enbles valued event registration with the PsEventCreator
   // as from g++3, it is no longer necessary in constructors
  static bool instanciated = myEventCreator.touch() ;
}


template <typename UserType>
PsValuedEvent<UserType>::~PsValuedEvent() 
{
   // this static ensures that the static members are present in the generated code
   // enabling correct linking. In this case, it enbles valued event registration with the PsEventCreator
   static bool instanciated = myEventCreator.touch() ;  
}



template <typename UserType>
void PsValuedEvent<UserType>::unpack (PsIncomingSynchronisationMessage & in)
{

   //un pack base information
   PsEvent::unpack ( in ) ;
   in >> value ;
}

template <typename UserType>
void PsValuedEvent<UserType>::pack(PsOutgoingSynchronisationMessage & out) const
{
   static PsName valueType ( typeid (PsValuedEvent<UserType>) .name() ) ;
   out << valueType
       << eventId 
       << date 
       << sender 
       << receiver
       << value ;
}


#endif

---