---

PsEvent Class Reference

Base class for all events exchanged between simulation objects. More...

#include <PsEvent.h>

Inheritance diagram for PsEvent:

[legend]Collaboration diagram for PsEvent:

[legend]List of all members.

member function for event manipulation
	PsEvent (const PsEvent &originalEvent)
	copy constructor
PsEvent &	operator= (const PsEvent &originalEvent)
	assignement
virtual PsEvent *	clone () const
	cloning
virtual void	insertInStream (ostream &out=cout) const
	insert in a stream
virtual void	extract (istream &in=cin)
	extract from a stream
virtual void	unpack (PsIncomingSynchronisationMessage &)
	unpack from a message when this member function is called, the 4 base fields (eventId, date, sender and receiver) have allready been unpacked.
virtual void	pack (PsOutgoingSynchronisationMessage &) const
	pack in a message
	PsEvent (const PsEventIdentifier &event, const PsDate &date, const PsName &sender, const PsName &receiver)
	the constructor
virtual	~PsEvent ()
	the destructor.
virtual bool	isSystem () const
	is the event a system event
PsEvent *	insertInList (list< PsEvent * > *alist, PsEvent *)
	insert an event in an event list, so that events are ordered from oldest to most recent
Public Attributes
The four base fields
PsEventIdentifier	eventId
	the event identifier
PsDate	date
	date of sending
PsName	sender
	sender of the event
PsName	receiver
	intended receiver
Static Protected Attributes
PsEventCreator *	_myEventCreator = new PsEventCreator ("PsEvent")

---

Detailed Description

Base class for all events exchanged between simulation objects.

Author:

[David Margery]{mailto:David.Margery@irisa.fr}.

Version:

1.9

Definition at line 35 of file PsEvent.h.

---

Constructor & Destructor Documentation

PsEvent::PsEvent (  const PsEvent &    originalEvent )

copy constructor Definition at line 28 of file PsEvent.cxx. Referenced by clone(). : eventId ( originalEvent.eventId ), date ( originalEvent.date ), sender ( originalEvent.sender ), receiver ( originalEvent.receiver ) { }

PsEvent::PsEvent (  const PsEventIdentifier &    event, const PsDate &    date, const PsName &    sender, const PsName &    receiver )

the constructor Parameters: event  : the event date  : date of sending sender  : sender receiver  : receiver Definition at line 89 of file PsEvent.cxx. References PsDate. : eventId ( eventId ), date ( date ), sender ( sender ), receiver (receiver ) { #ifdef _DEBUGEVT cerr<<"PsEvent::PsEvent(const PsEventIdentifier & eventId, const PsDate & date, const PsName & sender, const PsName & receiver )"<<endl; #endif }

PsEvent::~PsEvent (    )  [virtual]

the destructor. Definition at line 100 of file PsEvent.cxx. { //cerr<<"PsEvent::~PsEvent() "<<*this<<endl; }

---

Member Function Documentation

PsEvent * PsEvent::clone (    )  const [virtual]

cloning Reimplemented in PsValuedEvent< UserType >. Definition at line 47 of file PsEvent.cxx. References PsEvent(). Referenced by PsMomeController::actOnSystemEvent(), PsController::actOnSystemEvent(), PsnPvmDuplicatedObjectHandle::broadcastEvent(), PsDistributedController::broadcastEventsForSignal(), PsnReferenceObjectHandle::receiveEvent(), and PsSimulatedObject::sendEvent(). { return new PsEvent (*this) ; }

void PsEvent::extract (  istream &    in = cin )  [virtual]

extract from a stream Parameters: in  the stream from which the event must be extracted Implements PsFlowable. Reimplemented in PsValuedEvent< UserType >. Definition at line 81 of file PsEvent.cxx. References date, eventId, receiver, and sender. Referenced by PsValuedEvent< UserType >::extract(). { int i ; in >> eventId >> date >> sender >> receiver ; }

PsEvent * PsEvent::insertInList (  list< PsEvent * > *    alist, PsEvent *    )  [static]

insert an event in an event list, so that events are ordered from oldest to most recent Definition at line 112 of file PsEvent.cxx. References date, list< T, Alloc >::rbegin(), and list< T, Alloc >::rend(). Referenced by PsController::actOnSystemEvent(), and PsnReferenceObjectHandle::receiveEvent(). { list<PsEvent *>::reverse_iterator i = aList->rbegin () ; while ( i != aList->rend() && (event->date < (*i)->date ) ) { ++i ; } aList-> insert (i.base(),event) ; return event ; }

void PsEvent::insertInStream (  ostream &    out = cout )  const [virtual]

insert in a stream Parameters: out  the stream where the event must be printed Implements PsFlowable. Reimplemented in PsValuedEvent< UserType >. Definition at line 74 of file PsEvent.cxx. References date, eventId, receiver, and sender. Referenced by PsValuedEvent< UserType >::insertInStream(). { out << eventId << " " << date << " " << sender << " " << receiver << " " ; }

bool PsEvent::isSystem (    )  const [virtual]

is the event a system event Returns: the event is a system event Definition at line 106 of file PsEvent.cxx. References eventId, and PsEventIdentifier::isSystemEvent(). Referenced by PsnReferenceObjectHandle::receiveEvent(). { return eventId.isSystemEvent () ; }

PsEvent & PsEvent::operator= (  const PsEvent &    originalEvent )

assignement Definition at line 38 of file PsEvent.cxx. References date, eventId, receiver, and sender. Referenced by PsValuedEvent< UserType >::operator=(). { eventId = evenement.eventId ; date = evenement.date ; sender = evenement.sender ; receiver = evenement.receiver ; return(*this); }

void PsEvent::pack (  PsOutgoingSynchronisationMessage &    )  const [virtual]

pack in a message Reimplemented from PsFlowable. Reimplemented in PsValuedEvent< UserType >. Definition at line 59 of file PsEvent.cxx. References date, eventId, receiver, and sender. { static PsName eventWithNoValue ("PsEvent") ; #ifdef _DEBUGPVMMESS cerr<<"PsEvent::pack"<<endl; #endif out << eventWithNoValue << eventId << date << sender << receiver ; }

void PsEvent::unpack (  PsIncomingSynchronisationMessage &    )  [virtual]

unpack from a message when this member function is called, the 4 base fields (eventId, date, sender and receiver) have allready been unpacked. This is necessary to enable correct un packing of valuedEvents Reimplemented from PsFlowable. Reimplemented in PsValuedEvent< UserType >. Definition at line 53 of file PsEvent.cxx. Referenced by PsValuedEvent< UserType >::unpack(), PsnPvmReferenceObjectHandle::unpack(), and PsnPvmDuplicatedObjectHandle::unpack(). { //do nothing : all usefull information has allready been unpacked }

---

Member Data Documentation

PsEventCreator * PsEvent::_myEventCreator = new PsEventCreator ("PsEvent") [static, protected]

Definition at line 24 of file PsEvent.cxx.

PsDate PsEvent::date

date of sending Definition at line 46 of file PsEvent.h. Referenced by extract(), insertInList(), insertInStream(), operator=(), PsValuedEvent< UserType >::pack(), pack(), PsDistributedController::processEvent(), PsController::processEvent(), PsnReferenceObjectHandle::receiveEvent(), and PsSimulatedObject::sendEvent().

PsEventIdentifier PsEvent::eventId

the event identifier Definition at line 42 of file PsEvent.h. Referenced by extract(), insertInStream(), isSystem(), operator=(), PsValuedEvent< UserType >::pack(), pack(), PsInputConnectionEventListener< Type >::processEvent(), PsDistributedController::processEvent(), PsController::processEvent(), PsController::reactToControlledObjectsSystemEvents(), PsnReferenceObjectHandle::receiveEvent(), PsnMomeReferenceObjectHandle::receiveEvent(), PsSimulatedObject::sendEvent(), and PsnSignalDispatcher::sendEventsForSignal().

PsName PsEvent::receiver

intended receiver Definition at line 54 of file PsEvent.h. Referenced by PsMomeController::actOnSystemEvent(), PsController::actOnSystemEvent(), PsController::addToPendingEvents(), PsDistributedController::dispatchEvent(), extract(), insertInStream(), operator=(), PsValuedEvent< UserType >::pack(), pack(), PsDistributedController::processEvent(), PsController::reactToControlledObjectsSystemEvents(), PsnReferenceObjectHandle::receiveEvent(), PsSimulatedObject::sendEvent(), and PsnSignalDispatcher::sendEventsForSignal().

PsName PsEvent::sender

sender of the event Definition at line 50 of file PsEvent.h. Referenced by extract(), insertInStream(), operator=(), PsValuedEvent< UserType >::pack(), pack(), PsInputConnectionEventListener< Type >::processEvent(), and PsnMomeReferenceObjectHandle::receiveEvent().

---

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

• PsEvent.h
• PsEvent.cxx

---