OMK::ValuedEventSignalEmitterUtilT< T, ModelType > Class Template Reference

Base class to emit a valued event. More...

#include <OMKEventSignalEmitterUtil.h>

Inheritance diagram for OMK::ValuedEventSignalEmitterUtilT< T, ModelType >:

[legend]Collaboration diagram for OMK::ValuedEventSignalEmitterUtilT< T, ModelType >:

[legend]List of all members.

Public Member Functions
virtual	~ValuedEventSignalEmitterUtilT ()
Protected Member Functions
	ValuedEventSignalEmitterUtilT ()
	Constructor.
virtual bool	loadParametersUtil (ExtensibleSimulatedObject *owner, const ConfigurationParameterDescriptor *node)
virtual void	sendUtil (ExtensibleSimulatedObject *owner)
	The overwritten method.
Protected Attributes
std::vector< T >	_values
	The value to send.
std::vector< T >::iterator	_current
	The current iterator.

---

Detailed Description

template<typename T, typename ModelType>
class OMK::ValuedEventSignalEmitterUtilT< T, ModelType >

Base class to emit a valued event.

Author:

Benoît Chanclou

Definition at line 43 of file OMKEventSignalEmitterUtil.h.

---

Constructor & Destructor Documentation

template<typename T, typename ModelType>

OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::ValuedEventSignalEmitterUtilT

(

)

[inline, protected]

Constructor.

It is protected, because it is only called by the sons.

Definition at line 49 of file OMKEventSignalEmitterUtil.h.

    : EventSignalEmitterUtil(),
    _current()
  {
  }

template<typename T, typename ModelType>

virtual OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::~ValuedEventSignalEmitterUtilT

(

)

[inline, virtual]

Definition at line 56 of file OMKEventSignalEmitterUtil.h.

{}

---

Member Function Documentation

template<typename T, typename ModelType>

virtual bool OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::loadParametersUtil	(	ExtensibleSimulatedObject *	owner,
		const ConfigurationParameterDescriptor *	node
	)			[inline, protected, virtual]

Reimplemented from OMK::EventSignalEmitterUtil.

Definition at line 58 of file OMKEventSignalEmitterUtil.h.

References OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::_current, OMK::EventSignalEmitterUtil::_eventId, OMK::EventSignalEmitterUtil::_listeners, OMK::EventSignalEmitterUtil::_signal, OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::_values, OMK::ParametersAccessor::get(), OMK::ExtensibleSimulatedObject::getAttribute(), OMK::Name::getCString(), OMK::EventId::getCurrentValueEventId(), OMK::SimulatedObject::getName(), OMK::EventSignalEmitterUtil::loadParametersUtil(), and OMERROR.

Referenced by OMK::TriggerEmitterExtensionT< T, ModelType >::loadExtensionParameters(), and OMK::Inp::KeyEmitterExtensionT< T, ModelType >::loadExtensionParameters().

  {
    bool ok = true ;
    if( ParametersAccessor::get( node, "AttributeId", _eventId, owner ) )
    {
      IAttribute * attribute = owner->getAttribute( _eventId ) ;
      ok = ok && attribute ;
      if( !attribute ) OMERROR( "Attribute " << _eventId << " cannot be found" ) ;
      if( ok )
      {
        attribute->activateSetByEventOf() ;
        _eventId = EventId::getCurrentValueEventId( _eventId.getCString() ) ;
        _listeners.push_back( owner->getName() ) ;
        _signal = false ;
      }
    }
    else
    {
      ok = ok && EventSignalEmitterUtil::loadParametersUtil( owner, node ) ;
    }
    ok = ok && ParametersAccessor::get( node, "Values", _values, owner ) ;
    _current = _values.begin() ;
    return ok ;
  }

template<typename T, typename ModelType>

virtual void OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::sendUtil

(

ExtensibleSimulatedObject *

owner

)

[inline, protected, virtual]

The overwritten method.

Fire a signal or send an event according to the configuration.

Reimplemented from OMK::EventSignalEmitterUtil.

Definition at line 89 of file OMKEventSignalEmitterUtil.h.

References OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::_current, OMK::EventSignalEmitterUtil::_eventId, OMK::EventSignalEmitterUtil::_listeners, OMK::EventSignalEmitterUtil::_signal, OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::_values, OMK::SimulatedObject::fireValuedSignal(), OMK_DEBUG_OMK_EVENT, OMTRACEID, and OMK::SimulatedObject::sendValuedEvent().

Referenced by OMK::Inp::KeyEmitterExtensionT< T, ModelType >::action().

  {
    if( _signal )
    { // Fire the signal
      owner->fireValuedSignal< ModelType >( _eventId, ModelType( *_current ) ) ;
    }
    else
    { // Send the event for each listener
      for( std::vector< Name >::const_iterator i = _listeners.begin() ;
           i != _listeners.end() ;
           i++ )
      {
        OMTRACEID( OMK_DEBUG_OMK_EVENT, "send value \"" << *_current << "\" to \"" << *i << "\" through event \"" << _eventId << "\"" ) ;
        owner->sendValuedEvent< ModelType >( *i, _eventId, ModelType( *_current ) ) ;
      }
    }
    // Next one 
    _current++ ;
    if( _current == _values.end() ) _current = _values.begin() ;
  }

---

Member Data Documentation

template<typename T, typename ModelType>

std::vector< T > OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::_values [protected]

The value to send.

Definition at line 84 of file OMKEventSignalEmitterUtil.h.

Referenced by OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::loadParametersUtil(), and OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::sendUtil().

template<typename T, typename ModelType>

std::vector< T >::iterator OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::_current [protected]

The current iterator.

Definition at line 86 of file OMKEventSignalEmitterUtil.h.

Referenced by OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::loadParametersUtil(), and OMK::ValuedEventSignalEmitterUtilT< T, ModelType >::sendUtil().

---