OMK::ChangedControlParameterEventListener< T > Class Template Reference

the base event listener for reacting to proposed changes to a control parameter implementing default behaviour the last suggested change arriving to the object is enacted More...

#include <OMKChangedControlParameterEventListener.h>

Inheritance diagram for OMK::ChangedControlParameterEventListener< T >:

[legend]Collaboration diagram for OMK::ChangedControlParameterEventListener< T >:

[legend]List of all members.

Public Member Functions
	ChangedControlParameterEventListener (SimulatedObject &owner, ControlParameter< T > &associatedControlParameter)
	constructor
virtual	~ChangedControlParameterEventListener ()
	destructor
virtual void	registerEvents ()
	redefine to register the event emitted by the control parameter when new values are suggested
virtual bool	processEvent (Event *event)
	process the suggested changes
Protected Member Functions
virtual void	setControlParameter (const T &newValue)
	enforce newValue as a value for the associatedControlParameter
Protected Attributes
ControlParameter< T > &	_associatedControlParameter
	the control parameter this event listener is montoring the change of

---

Detailed Description

template<typename T>
class OMK::ChangedControlParameterEventListener< T >

the base event listener for reacting to proposed changes to a control parameter implementing default behaviour the last suggested change arriving to the object is enacted

Author:

David Margery (last revision by

Author

chauffau

)

Version:

1.0 (revision

Revision

1.1.1.1

)

Definition at line 31 of file OMKChangedControlParameterEventListener.h.

---

Constructor & Destructor Documentation

template<typename T>

OMK::ChangedControlParameterEventListener< T >::ChangedControlParameterEventListener	(	SimulatedObject &	owner,
		ControlParameter< T > &	associatedControlParameter
	)

constructor

Parameters:

owner

owner of the event listener associatedControlParameter the control parameter this event listener is listening for

Definition at line 63 of file OMKChangedControlParameterEventListener.h.

References OMK::EventListener::_owner, and OMK::SimulatedObject::addEventListener().

                                                                                         :
EventListener ( owner ),
   _associatedControlParameter( associatedControlParameter )
{
  _owner.addEventListener( *this ) ;     
}

template<typename T>

OMK::ChangedControlParameterEventListener< T >::~ChangedControlParameterEventListener

(

)

[virtual]

destructor

Definition at line 75 of file OMKChangedControlParameterEventListener.h.

{

}

---

Member Function Documentation

template<typename T>

void OMK::ChangedControlParameterEventListener< T >::registerEvents

(

)

[virtual]

redefine to register the event emitted by the control parameter when new values are suggested

Reimplemented from OMK::EventListener.

Definition at line 82 of file OMKChangedControlParameterEventListener.h.

References OMK::ChangedControlParameterEventListener< T >::_associatedControlParameter, OMK::EventListener::_owner, and OMK::SimulatedObject::registerEventListenerForEvent().

{
   _owner.registerEventListenerForEvent ( *this, _associatedControlParameter.getAssociatedEventId() ) ;
}

template<typename T>

bool OMK::ChangedControlParameterEventListener< T >::processEvent

(

Event *

event

)

[virtual]

process the suggested changes

Implements OMK::EventListener.

Definition at line 89 of file OMKChangedControlParameterEventListener.h.

References OMK::ChangedControlParameterEventListener< T >::setControlParameter(), and OMK::ValuedEvent< UserType >::value.

{
   ValuedEvent<T > * realEvent = dynamic_cast<ValuedEvent<T > *>(event) ;
   assert ( realEvent != NULL );
   setControlParameter ( realEvent->value ) ;
   return true ;
}

template<typename T>

void OMK::ChangedControlParameterEventListener< T >::setControlParameter

(

const T &

newValue

)

[protected, virtual]

enforce newValue as a value for the associatedControlParameter

Definition at line 99 of file OMKChangedControlParameterEventListener.h.

References OMK::ChangedControlParameterEventListener< T >::_associatedControlParameter.

Referenced by OMK::ChangedControlParameterEventListener< T >::processEvent().

{
   _associatedControlParameter.realSet ( value ) ;

}

---

Member Data Documentation

template<typename T>

ControlParameter<T>& OMK::ChangedControlParameterEventListener< T >::_associatedControlParameter [protected]

the control parameter this event listener is montoring the change of

Definition at line 55 of file OMKChangedControlParameterEventListener.h.

Referenced by OMK::ChangedControlParameterEventListener< T >::registerEvents(), and OMK::ChangedControlParameterEventListener< T >::setControlParameter().

---