OMK::Iii::InteractorOutputT< PrmType, ModelType > Class Template Reference

#include <OMKInteractorOutputT.h>

Inheritance diagram for OMK::Iii::InteractorOutputT< PrmType, ModelType >:

[legend]Collaboration diagram for OMK::Iii::InteractorOutputT< PrmType, ModelType >:

[legend]List of all members.

Public Types
typedef std::pair< Name, ModelType >	IdAndValuePrm
	The type of the data to update or retrieve the attibute value.
Public Member Functions
	DECLARE_TYPE_EVENT_LISTENER (IdAndValuePrm, IdAndValue, EventTypeForAttributeT< ModelType >)
	The type of the event to update or retrieve the attibute value.
virtual	~InteractorOutputT ()
Protected Member Functions
	InteractorOutputT (const Name &id, const Name &attributeId, InteractorExtension *interactor, const Name &category, bool setByEvent)
virtual bool	processSetValue (IdAndValueEvent *e)
	The call back method to process the update of the attribute value.
Protected Attributes
IAttributeBaseT< PrmType > *	_attribute
	The attribute interface.
IdAndValueEventListener *	_listener
Friends
class	OMK::Iii::InteractorOutputCreatorT< InteractorOutputT >

---

Detailed Description

template<typename PrmType, typename ModelType>
class OMK::Iii::InteractorOutputT< PrmType, ModelType >

Definition at line 37 of file OMKInteractorOutputT.h.

---

Member Typedef Documentation

template<typename PrmType, typename ModelType>

typedef std::pair< Name, ModelType > OMK::Iii::InteractorOutputT< PrmType, ModelType >::IdAndValuePrm

The type of the data to update or retrieve the attibute value.

This is a pair in which the first item is an id and the second is the value.

See sendValue and fireValue.

Reimplemented from OMK::EventTypeForAttributeT< ModelType >.

Definition at line 45 of file OMKInteractorOutputT.h.

---

Constructor & Destructor Documentation

template<typename PrmType, typename ModelType>

OMK::Iii::InteractorOutputT< PrmType, ModelType >::InteractorOutputT	(	const Name &	id,
		const Name &	attributeId,
		InteractorExtension *	interactor,
		const Name &	category,
		bool	setByEvent
	)			[protected]

Definition at line 36 of file OMKInteractorOutputT.inl.

References OMK::Iii::InteractorOutputT< PrmType, ModelType >::_attribute, OMK::Iii::InteractorOutput::_interactor, OMK::Iii::InteractorOutputT< PrmType, ModelType >::_listener, OMK::EventId::CURRENT_VALUE, OMK::ExtensionT< SimulatedObjectType >::getOwner(), and OMASSERTM.

: InteractorOutput( id, interactor, category, typeid( PrmType ).name() ),
  _attribute( interactor->getOwner()->getBaseAttribute< PrmType >( attributeId ) ),
  _listener( 0 )
{
  OMASSERTM( _attribute, "The attribute \"" << attributeId << "\" cannot be found, wrong type or wrong id!" ) ;
  if( setByEvent )
  {
    _listener = new IdAndValueEventListener
        ( *_interactor->getOwner(), this, 
        ( typename IdAndValueEventListener::CallBackFct)&InteractorOutputT< PrmType, ModelType >::processSetValue,
        EventId::CURRENT_VALUE ) ;
  }
}

template<typename PrmType, typename ModelType>

OMK::Iii::InteractorOutputT< PrmType, ModelType >::~InteractorOutputT

(

)

[virtual]

Definition at line 54 of file OMKInteractorOutputT.inl.

References OMK::Iii::InteractorOutputT< PrmType, ModelType >::_listener.

{
  delete _listener ;
}

---

Member Function Documentation

template<typename PrmType, typename ModelType>

OMK::Iii::InteractorOutputT< PrmType, ModelType >::DECLARE_TYPE_EVENT_LISTENER	(	IdAndValuePrm	,
		IdAndValue	,
		EventTypeForAttributeT< ModelType >
	)

The type of the event to update or retrieve the attibute value.

This is a pair encapsulated in a valued event in which the first item is an id and the second is the value.

See sendValue and fireValue.

Reimplemented from OMK::EventTypeForAttributeT< ModelType >.

template<typename PrmType, typename ModelType>

bool OMK::Iii::InteractorOutputT< PrmType, ModelType >::processSetValue

(

IdAndValueEvent *

e

)

[protected, virtual]

The call back method to process the update of the attribute value.

Parameters:

[in]

e

The valued event which encapsulate the new value.

Returns:

true if processed.

Implements OMK::EventTypeForAttributeT< ModelType >.

Definition at line 60 of file OMKInteractorOutputT.inl.

References OMK::Iii::InteractorOutputT< PrmType, ModelType >::_attribute, OMK::Iii::InteractorOutput::_interactor, OMK::Iii::SessionPrm::getOutputId(), OMK::ExtensionT< SimulatedObjectType >::getOwner(), OMK::Iii::InteractorExtension::getSessionWith(), and OMK::EventId::NEW_VALUE_AVAILABLE.

{
  bool ok = false ;
  const IdAndValuePrm& prm = e->value.getValue() ;
  SessionPrm* session = _interactor->getSessionWith( e->sender ) ;
  if( session 
   && session->getOutputId( prm.first ) == _attribute->getId() ) 
  {
    _attribute->set( prm.second ) ;
    _interactor->getOwner()->sendValuedEvent( e->sender, 
                                              EventId::NEW_VALUE_AVAILABLE, 
                                              Type::NewValueAvailableType( Type::NewValueAvailablePrm( prm.first, _attribute->getId() ) ) ) ;
    ok = true ;
  }
  return ok ;
}

---

Friends And Related Function Documentation

template<typename PrmType, typename ModelType>

friend class OMK::Iii::InteractorOutputCreatorT< InteractorOutputT > [friend]

Definition at line 40 of file OMKInteractorOutputT.h.

---

Member Data Documentation

template<typename PrmType, typename ModelType>

IAttributeBaseT< PrmType >* OMK::Iii::InteractorOutputT< PrmType, ModelType >::_attribute [protected]

The attribute interface.

Definition at line 52 of file OMKInteractorOutputT.h.

Referenced by OMK::Iii::InteractorOutputT< PrmType, ModelType >::InteractorOutputT(), and OMK::Iii::InteractorOutputT< PrmType, ModelType >::processSetValue().

template<typename PrmType, typename ModelType>

IdAndValueEventListener* OMK::Iii::InteractorOutputT< PrmType, ModelType >::_listener [protected]

Definition at line 53 of file OMKInteractorOutputT.h.

Referenced by OMK::Iii::InteractorOutputT< PrmType, ModelType >::InteractorOutputT(), and OMK::Iii::InteractorOutputT< PrmType, ModelType >::~InteractorOutputT().

---