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

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

#include <OMKEventSignalEmitterUtil.h>

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

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

[legend]List of all members.

Public Member Functions
virtual	~MultiValuedEventSignalEmitterUtilT ()
Protected Member Functions
	MultiValuedEventSignalEmitterUtilT ()
	Constructor.
virtual bool	loadParametersUtil (ExtensibleSimulatedObject *owner, const ConfigurationParameterDescriptor *node)
virtual void	sendUtil (ExtensibleSimulatedObject *owner, int index)
	The overwritten method.
Protected Attributes
std::vector< T >	_values
	The value to send.
int	_default
	Default index.

---

Detailed Description

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

Base class to emit a valued event.

Author:

Benoît Chanclou

Definition at line 116 of file OMKEventSignalEmitterUtil.h.

---

Constructor & Destructor Documentation

template<typename T, typename ModelType>

OMK::MultiValuedEventSignalEmitterUtilT< T, ModelType >::MultiValuedEventSignalEmitterUtilT

(

)

[inline, protected]

Constructor.

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

Definition at line 122 of file OMKEventSignalEmitterUtil.h.

    : EventSignalEmitterUtil(),
    _default( 0 )
  {
  }

template<typename T, typename ModelType>

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

(

)

[inline, virtual]

Definition at line 129 of file OMKEventSignalEmitterUtil.h.

{}

---

Member Function Documentation

template<typename T, typename ModelType>

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

Reimplemented from OMK::EventSignalEmitterUtil.

Definition at line 131 of file OMKEventSignalEmitterUtil.h.

References OMK::MultiValuedEventSignalEmitterUtilT< T, ModelType >::_default, OMK::EventSignalEmitterUtil::_eventId, OMK::EventSignalEmitterUtil::_listeners, OMK::EventSignalEmitterUtil::_signal, OMK::MultiValuedEventSignalEmitterUtilT< 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::MultiTriggerEmitterExtensionT< 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 ) ;
    ParametersAccessor::get( node, "Default", _default ) ;
    return ok ;
  }

template<typename T, typename ModelType>

virtual void OMK::MultiValuedEventSignalEmitterUtilT< T, ModelType >::sendUtil	(	ExtensibleSimulatedObject *	owner,
		int	index
	)			[inline, protected, virtual]

The overwritten method.

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

Definition at line 163 of file OMKEventSignalEmitterUtil.h.

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

  {
    // if index out of range then it uses the _default
    index = ( index < 0 || (int)_values.size() < index ) ? _default : index ;
    if( _signal )
    { // Fire the signal
      owner->fireValuedSignal< ModelType >( _eventId, ModelType( _values[ index ] ) ) ;
    }
    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[ " << index << " ] \"" << _values[ index ] << "\" to \"" << *i << "\" through event \"" << _eventId << "\"" ) ;
        owner->sendValuedEvent< ModelType >( *i, _eventId, ModelType( _values[ index ] ) ) ;
      }
    }
  }

---

Member Data Documentation

template<typename T, typename ModelType>

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

The value to send.

Definition at line 157 of file OMKEventSignalEmitterUtil.h.

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

template<typename T, typename ModelType>

int OMK::MultiValuedEventSignalEmitterUtilT< T, ModelType >::_default [protected]

Default index.

By default it is 0

Definition at line 160 of file OMKEventSignalEmitterUtil.h.

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

---