OMK::ValuedEvent< UserType > Class Template Reference

An event that carries an associated value. More...

#include <OMKValuedEvent.h>

Inheritance diagram for OMK::ValuedEvent< UserType >:

[legend]Collaboration diagram for OMK::ValuedEvent< UserType >:

[legend]List of all members.

Public Member Functions
	ValuedEvent (const ValuedEvent &originalEvent)
	Copy constructor.
ValuedEvent &	operator= (const ValuedEvent &originalEvent)
	Assignement.
virtual ValuedEvent *	clone () const
	Cloning.
virtual void	insertInStream (std::ostream &=std::cout) const
	Insert in stream.
virtual void	extract (std::istream &=std::cin)
	Extract from stream.
virtual void	unpack (IncomingSynchronisationMessage &)
	Unpack from a message.
virtual void	pack (OutgoingSynchronisationMessage &) const
	Pack in a message.
	ValuedEvent (const EventIdentifier &event, const Date &date, const Name &sender, const Name &receiver, const UserType &userValue)
	Constructor.
	ValuedEvent (const EventIdentifier &event, const Date &date, const Name &sender, const Name &receiver)
	Constructor.
virtual	~ValuedEvent ()
	Destructor.
Public Attributes
UserType	value
	The value carried by the event.
Static Public Attributes
static ValuedEventCreator	myEventCreator
	The local event creator.
Classes
class	ValuedEventCreator

---

Detailed Description

template<typename UserType>
class OMK::ValuedEvent< UserType >

An event that carries an associated value.

See DECLARE_PRM_TYPE_EVENT and DECLARE_PRM_TYPE_EVENT_LISTENER.

Definition at line 32 of file OMKValuedEvent.h.

---

Constructor & Destructor Documentation

template<typename UserType>

OMK::ValuedEvent< UserType >::ValuedEvent

(

const ValuedEvent< UserType > &

originalEvent

)

Copy constructor.

Definition at line 119 of file OMKValuedEvent.h.

References OMK::ValuedEvent< UserType >::myEventCreator, and OMK::EventCreator::touch().

                                                                               :
                                          Event ( 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 OMKEventCreator
  static bool instanciated = myEventCreator.touch() ;
  myEventCreator.touch(instanciated) ;
}

template<typename UserType>

OMK::ValuedEvent< UserType >::ValuedEvent	(	const EventIdentifier &	event,
		const Date &	date,
		const Name &	sender,
		const Name &	receiver,
		const UserType &	userValue
	)

Constructor.

Parameters:

	event,:	the event
	date,:	date of sending
	sender,:	sender
	receiver,:	receiver
	userValue,:	the value of the valued event

Definition at line 164 of file OMKValuedEvent.h.

References OMK::ValuedEvent< UserType >::myEventCreator, and OMK::EventCreator::touch().

                                                                       :
   Event(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 OMKEventCreator
   // as from g++3, it is no longer necessary in constructors
  static bool instanciated = myEventCreator.touch() ;
  myEventCreator.touch(instanciated) ;
}

template<typename UserType>

OMK::ValuedEvent< UserType >::ValuedEvent	(	const EventIdentifier &	event,
		const Date &	date,
		const Name &	sender,
		const Name &	receiver
	)

Constructor.

Parameters:

	event	: the event
	date	: date of sending
	sender	: sender
	receiver	: receiver

Definition at line 182 of file OMKValuedEvent.h.

References OMK::ValuedEvent< UserType >::myEventCreator, and OMK::EventCreator::touch().

                                                                  :
Event(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 OMKEventCreator
   // as from g++3, it is no longer necessary in constructors
  static bool instanciated = myEventCreator.touch() ;
  myEventCreator.touch(instanciated) ;
}

template<typename UserType>

OMK::ValuedEvent< UserType >::~ValuedEvent

(

)

[virtual]

Destructor.

Definition at line 197 of file OMKValuedEvent.h.

References OMK::ValuedEvent< UserType >::myEventCreator, and OMK::EventCreator::touch().

{
   // 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 OMKEventCreator
   static bool instanciated = myEventCreator.touch() ;  
  myEventCreator.touch(instanciated) ;
}

---

Member Function Documentation

template<typename UserType>

ValuedEvent< UserType > & OMK::ValuedEvent< UserType >::operator=

(

const ValuedEvent< UserType > &

originalEvent

)

Assignement.

Definition at line 132 of file OMKValuedEvent.h.

References OMK::Event::operator=(), and OMK::ValuedEvent< UserType >::value.

{
  Event::operator = ( originalEvent ) ;
  value = originalEvent.value ;
  return *this ;
}

template<typename UserType>

ValuedEvent< UserType > * OMK::ValuedEvent< UserType >::clone

(

)

const [virtual]

Cloning.

Reimplemented from OMK::Event.

Definition at line 142 of file OMKValuedEvent.h.

{
   return new ValuedEvent<UserType>( *this ) ;
}

template<typename UserType>

void OMK::ValuedEvent< UserType >::insertInStream

(

std::ostream &

= std::cout

)

const [virtual]

Insert in stream.

Parameters:

out

: stream where insert message

Reimplemented from OMK::Event.

Definition at line 150 of file OMKValuedEvent.h.

References OMK::Event::insertInStream(), and OMK::ValuedEvent< UserType >::value.

{
  Event::insertInStream ( out ) ;
   out<<value<<" ";
}

template<typename UserType>

void OMK::ValuedEvent< UserType >::extract

(

std::istream &

= std::cin

)

[virtual]

Extract from stream.

Parameters:

in

: stream where extract message

Reimplemented from OMK::Event.

Definition at line 157 of file OMKValuedEvent.h.

References OMK::Event::extract(), and OMK::ValuedEvent< UserType >::value.

{
  Event::extract ( in ) ;
   in >> value ;
}

template<typename UserType>

void OMK::ValuedEvent< UserType >::unpack

(

IncomingSynchronisationMessage &

)

[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 OMK::Event.

Definition at line 206 of file OMKValuedEvent.h.

References OMK::Event::unpack(), and OMK::ValuedEvent< UserType >::value.

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

template<typename UserType>

void OMK::ValuedEvent< UserType >::pack

(

OutgoingSynchronisationMessage &

)

const [virtual]

Pack in a message.

Reimplemented from OMK::Event.

Definition at line 214 of file OMKValuedEvent.h.

References OMK::Event::date, OMK::Event::eventId, OMK::Event::receiver, OMK::Event::sender, and OMK::ValuedEvent< UserType >::value.

{
   static Name valueType( typeid( ValuedEvent< UserType > ).name() ) ;
   out << valueType
       << eventId 
       << date 
       << sender 
       << receiver
       << value ;
}

---

Member Data Documentation

template<typename UserType>

UserType OMK::ValuedEvent< UserType >::value

The value carried by the event.

Definition at line 37 of file OMKValuedEvent.h.

Referenced by OMK::ValuedEvent< UserType >::extract(), OMK::ValuedEvent< UserType >::insertInStream(), OMK::ValuedEvent< UserType >::operator=(), OMK::ValuedEvent< UserType >::pack(), OMK::InputConnectionEventListener< T >::processEvent(), OMK::DistributedController::processEvent(), OMK::ChangedControlParameterEventListener< T >::processEvent(), OMK::IAttribute::processGetValue(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::processSetValueOf(), OMK::Controller::reactToControlledObjectsSystemEvents(), OMK::Vis::AnimatorEventPlugT< T >::setEvent(), and OMK::ValuedEvent< UserType >::unpack().

template<typename UserType>

ValuedEvent< UserType >::ValuedEventCreator OMK::ValuedEvent< UserType >::myEventCreator [static]

The local event creator.

Definition at line 108 of file OMKValuedEvent.h.

Referenced by OMK::ValuedEvent< UserType >::ValuedEvent(), and OMK::ValuedEvent< UserType >::~ValuedEvent().

---