OMK::Iii::InteractorExtension Class Reference
[Interactive object, Interactor, Inspectable object, Inspector]

Ancestor of every interactive, interactor or inspector objects. More...

#include <OMKInteractorExtension.h>

Inheritance diagram for OMK::Iii::InteractorExtension:

[legend]Collaboration diagram for OMK::Iii::InteractorExtension:

[legend]List of all members.

Sessions handling.
SessionsMap	_sessionsPrm
	Map of session parameters.
virtual void	startSessionWith (const Name &interactiveObject)
	Method to start a new session.
virtual void	closeSessionWith (const Name &interactiveObject)
	Method to close a session.
SessionPrm *	getSessionWith (const Name &interactiveObject)
	Method to retrieve the session associated with the interactive object.
void	closeAllSessions ()
	Method to close all the sessions.
virtual SessionPrm *	createSession (const Name &interactiveObject)
	Method to create a new session.
Events processing.
EventListener *	_accessibleConnectorsListener
	Pointer to aggregate the "accessible connectors" listener.
EventListener *	_currentValuesSentAndControlTakenListener
	Pointer to aggregate the "control taken and get current values sent" listener.
EventListener *	_controlReleasedListener
	Pointer to aggregate the "control released" listener.
EventListener *	_controlEndedListener
	Pointer to aggregate the "control ended" listener.
EventListener *	_controlTakenByListener
	Pointer to aggregate the "control taken by" listener.
EventListener *	_controlReleasedByListener
	Pointer to aggregate the "control released by" listener.
EventListener *	_currentValuesSentListener
	Pointer to aggregate the "current values sent" listener.
virtual bool	processAccessibleParameters (Type::AccessibleParametersListEvent *event)
	Process the "available_connectors" event.
virtual bool	processCurrentValuesSentAndControlTaken (Type::ControlTakenEvent *event)
	Process the "control_taken" event.
virtual bool	processControlReleased (Type::ControlReleasedEvent *event)
	Process the "control_released" event.
virtual bool	processControlEnded (Type::ControlEndedEvent *event)
	Process the "control_ended" event.
virtual bool	processControlTakenBy (Type::ControlUpdatedEvent *event)
virtual bool	processControlReleasedBy (Type::ControlUpdatedEvent *event)
virtual bool	processCurrentValuesSent (Event *event)
	Process the "current_values_sent" event.
Public Member Functions
ExtensibleSimulatedObject *	getInteractor ()
OMK::Type::AccessLevel	getAccessLevel () const
	Get the access level of the interactor.
void	setAccessLevel (OMK::Type::AccessLevel level=0)
	Set the access level of the interactor.
const OMK::Name &	getGroup () const
	Get the group name of the interactor.
void	setGroup (const OMK::Name &name)
	Set the group name of the interactor.
const OMK::Type::AccessGroup &	getAccessGroup () const
void	addInteractorOutput (InteractorOutput *interactorOutput)
	Method to add output connectors.
Protected Member Functions
Interactor interface
virtual bool	loadExtensionParameters (const ConfigurationParameterDescriptor *node)
	This method initialises the interactor.
virtual void	startInteractor ()
	This method initialises the interactor mode of the object.
Protected Attributes
OMK::Type::AccessGroup	_access
	Level access and group of the interactor.
InteractorOutputsMap	_interactorOutputs
	Output connectors map.

---

Detailed Description

Ancestor of every interactive, interactor or inspector objects.

Date:

2006-10-12

Author:

Benoît Chanclou

Module description :

Use it by derivation to add the necessary methods. This base class is abstract and never implemented, only the derivate classes are. All the members of this class are protected except the destructor according to the OpenMASK precepts.
This class defines all the items to create an interactive, interactor or inspector object.

See the introduction to the interaction protocols

Definition at line 53 of file OMKInteractorExtension.h.

---

Constructor & Destructor Documentation

InteractorExtension::~InteractorExtension

(

)

[virtual]

Destructor of InteractorObject.

Definition at line 88 of file OMKInteractorExtension.cpp.

References _accessibleConnectorsListener, _controlEndedListener, _controlReleasedByListener, _controlReleasedListener, _controlTakenByListener, _currentValuesSentAndControlTakenListener, _currentValuesSentListener, _interactorOutputs, and closeAllSessions().

{
  //Removes event listener
  delete _accessibleConnectorsListener ;
  delete _currentValuesSentAndControlTakenListener ;
  delete _controlReleasedListener ;
  delete _controlEndedListener ;
  delete _controlTakenByListener ;
  delete _controlReleasedByListener ;
  delete _currentValuesSentListener ;
  
  // Destroy each session
  closeAllSessions() ;

  // Destroy each connector, which will disconnect its associated input
  for ( InteractorOutputsMap::const_iterator i = _interactorOutputs.begin() ; i !=  _interactorOutputs.end() ; ++i )
  {
    delete i->second ;
  }
  // Finally clears the map 
  _interactorOutputs.clear() ;
}

InteractorExtension::InteractorExtension	(	ExtensibleSimulatedObject *	owner,
		const Name &	id,
		bool	registerExtension = true
	)			[protected]

Protected constructor of InteractorObject call by derivate classes.

Definition at line 41 of file OMKInteractorExtension.cpp.

References OMK::Extension::_id, OMK::ExtensionT< SimulatedObjectType >::_owner, OMK::IAttribute::createOutput(), OMK::debugMsg(), OMK::Name::getCString(), OMK::ConfigurationParameterDescriptor::getNumberOfSubItems(), OMK::IAttribute::getOutput(), OMK::ConfigurationParameterDescriptor::getSubDescriptorByName(), OMK_DEBUG_III, and OMTRACEID.

: ExtensionT< ExtensibleSimulatedObject >( owner, id, registerExtension ),
  _access( "", 1 ),
  _accessibleConnectorsListener( 0 ),
  _currentValuesSentAndControlTakenListener( 0 ),
  _controlReleasedListener( 0 ),
  _controlEndedListener( 0 ),
  _controlTakenByListener( 0 ),
  _controlReleasedByListener( 0 ),
  _currentValuesSentListener( 0 )
{
  // To be sure that there is an output all the interactor output are scanned
  const ConfigurationParameterDescriptor * node = _owner->getObjectDescriptor().getExtensionsParameters() ;
  const ConfigurationParameterDescriptor * extNode = node ? node->getSubDescriptorByName( _id.getCString() ) : 0 ;
  const ConfigurationParameterDescriptor * outputNode = extNode ? extNode->getSubDescriptorByName( "Outputs" ) : 0 ;
  if( outputNode )
  {
    int nbItems = outputNode->getNumberOfSubItems() ;
    OMTRACEID( OMK_DEBUG_III, "The interactor " <<  OMK::debugMsg( this, _owner ) << " has " << nbItems << " outputs" ) ;
    for( int i = 0 ; i < nbItems ; ++i )
    { 
      // Retrieves parameters sets for each interactor output
      Name id( static_cast<const MultipleConfigurationParameter *>( outputNode )->getNameOfSubDescriptor( i ) ) ;
      IAttribute* attribute = _owner->getAttribute( id ) ;
      if( attribute )
      {
        // To be sure that there is an output
        attribute->createOutput() ;
        OMTRACEID( OMK_DEBUG_III, ( attribute->getOutput() ? ":-)" : ":-(" ) << " Create the output for \"" << id << "\" !" ) ; 
      }
      else
      {
        OMTRACEID( OMK_DEBUG_III, ":-( Error the interactor " <<  OMK::debugMsg( this, _owner ) << std::endl
                 << ">>> Unable to create the output for \"" << id << "\" because this attribute doesn't exist !" ) ; 
      }
    }
  }
  else
  {
    OMTRACEID( OMK_DEBUG_III, ":-( Error the interactor " <<  OMK::debugMsg( this, _owner ) << std::endl
              << ">>> Unable to find the output node !" ) ; 
  }
}

InteractorExtension::~InteractorExtension

(

)

[virtual]

Destructor of InteractorObject.

Definition at line 88 of file OMKInteractorExtension.cpp.

References _accessibleConnectorsListener, _controlEndedListener, _controlReleasedByListener, _controlReleasedListener, _controlTakenByListener, _currentValuesSentAndControlTakenListener, _currentValuesSentListener, _interactorOutputs, and closeAllSessions().

{
  //Removes event listener
  delete _accessibleConnectorsListener ;
  delete _currentValuesSentAndControlTakenListener ;
  delete _controlReleasedListener ;
  delete _controlEndedListener ;
  delete _controlTakenByListener ;
  delete _controlReleasedByListener ;
  delete _currentValuesSentListener ;
  
  // Destroy each session
  closeAllSessions() ;

  // Destroy each connector, which will disconnect its associated input
  for ( InteractorOutputsMap::const_iterator i = _interactorOutputs.begin() ; i !=  _interactorOutputs.end() ; ++i )
  {
    delete i->second ;
  }
  // Finally clears the map 
  _interactorOutputs.clear() ;
}

InteractorExtension::InteractorExtension	(	ExtensibleSimulatedObject *	owner,
		const Name &	id,
		bool	registerExtension = true
	)			[protected]

Protected constructor of InteractorObject call by derivate classes.

Definition at line 41 of file OMKInteractorExtension.cpp.

References OMK::Extension::_id, OMK::ExtensionT< SimulatedObjectType >::_owner, OMK::IAttribute::createOutput(), OMK::debugMsg(), OMK::Name::getCString(), OMK::ConfigurationParameterDescriptor::getNumberOfSubItems(), OMK::IAttribute::getOutput(), OMK::ConfigurationParameterDescriptor::getSubDescriptorByName(), OMK_DEBUG_III, and OMTRACEID.

: ExtensionT< ExtensibleSimulatedObject >( owner, id, registerExtension ),
  _access( "", 1 ),
  _accessibleConnectorsListener( 0 ),
  _currentValuesSentAndControlTakenListener( 0 ),
  _controlReleasedListener( 0 ),
  _controlEndedListener( 0 ),
  _controlTakenByListener( 0 ),
  _controlReleasedByListener( 0 ),
  _currentValuesSentListener( 0 )
{
  // To be sure that there is an output all the interactor output are scanned
  const ConfigurationParameterDescriptor * node = _owner->getObjectDescriptor().getExtensionsParameters() ;
  const ConfigurationParameterDescriptor * extNode = node ? node->getSubDescriptorByName( _id.getCString() ) : 0 ;
  const ConfigurationParameterDescriptor * outputNode = extNode ? extNode->getSubDescriptorByName( "Outputs" ) : 0 ;
  if( outputNode )
  {
    int nbItems = outputNode->getNumberOfSubItems() ;
    OMTRACEID( OMK_DEBUG_III, "The interactor " <<  OMK::debugMsg( this, _owner ) << " has " << nbItems << " outputs" ) ;
    for( int i = 0 ; i < nbItems ; ++i )
    { 
      // Retrieves parameters sets for each interactor output
      Name id( static_cast<const MultipleConfigurationParameter *>( outputNode )->getNameOfSubDescriptor( i ) ) ;
      IAttribute* attribute = _owner->getAttribute( id ) ;
      if( attribute )
      {
        // To be sure that there is an output
        attribute->createOutput() ;
        OMTRACEID( OMK_DEBUG_III, ( attribute->getOutput() ? ":-)" : ":-(" ) << " Create the output for \"" << id << "\" !" ) ; 
      }
      else
      {
        OMTRACEID( OMK_DEBUG_III, ":-( Error the interactor " <<  OMK::debugMsg( this, _owner ) << std::endl
                 << ">>> Unable to create the output for \"" << id << "\" because this attribute doesn't exist !" ) ; 
      }
    }
  }
  else
  {
    OMTRACEID( OMK_DEBUG_III, ":-( Error the interactor " <<  OMK::debugMsg( this, _owner ) << std::endl
              << ">>> Unable to find the output node !" ) ; 
  }
}

---

Member Function Documentation

bool InteractorExtension::loadExtensionParameters

(

const ConfigurationParameterDescriptor *

node

)

[protected, virtual]

This method initialises the interactor.

Load the parameters to create the interactor outputs.

Reimplemented from OMK::Extension.

Reimplemented in OMK::Iii::JointInteractorExtension.

Definition at line 112 of file OMKInteractorExtension.cpp.

References _access, OMK::Type::AccessGroup::_groupName, OMK::Type::AccessGroup::_level, OMK::ExtensionT< SimulatedObjectType >::_owner, OMK::Iii::InteractorOutput::create(), OMK::debugMsg(), OMK::ParametersAccessor::get(), OMK::ConfigurationParameterDescriptor::getNumberOfSubItems(), OMK::ConfigurationParameterDescriptor::getSubDescriptorByName(), OMK_DEBUG_III, OMTRACEID, and startInteractor().

{
  bool ok = true ;

  ParametersAccessor::get( node, "Level", _access._level ) ; 
  ok = ParametersAccessor::get( node, "Group", _access._groupName ) && ok ; 
  OMTRACEID( OMK_DEBUG_III, "The interactor" <<  OMK::debugMsg( this, _owner ) 
                         << " is in the group \"" << _access._groupName 
                         << "\" and has the level " << _access._level ) ;

  startInteractor() ;

  const ConfigurationParameterDescriptor * outputNode = node->getSubDescriptorByName( "Outputs" ) ;
  if( outputNode )
  {
    int nbItems = outputNode->getNumberOfSubItems() ;
    OMTRACEID( OMK_DEBUG_III, "The interactor " <<  OMK::debugMsg( this, _owner ) << " has " << nbItems << " outputs" ) ;
    for( int i = 0 ; i < nbItems && ok ; ++i )
    { 
      // Retrieves parameters sets for each interactor output
      Name id( static_cast<const MultipleConfigurationParameter *>( outputNode )->getNameOfSubDescriptor( i ) ) ;
      const ConfigurationParameterDescriptor * outputParameters = outputNode->getSubDescriptorByPosition( i ) ;
      ok = InteractorOutput::create( id, this, outputParameters ) && ok ;
    }
  }

  return ok  ;
}

void InteractorExtension::startInteractor

(

)

[protected, virtual]

This method initialises the interactor mode of the object.

Initialising the interactor mode is to create the appropriate event listeners.

Definition at line 142 of file OMKInteractorExtension.cpp.

References _accessibleConnectorsListener, _controlEndedListener, _controlReleasedByListener, _controlReleasedListener, _controlTakenByListener, _currentValuesSentAndControlTakenListener, _currentValuesSentListener, OMK::ExtensionT< SimulatedObjectType >::_owner, OMK::EventId::ACCESSIBLE_PARAMETERS, OMK::EventId::CONTROL_ENDED, OMK::EventId::CONTROL_RELEASED, OMK::EventId::CONTROL_RELEASED_BY, OMK::EventId::CONTROL_TAKEN_BY, OMK::EventId::CURRENT_VALUES_SENT, OMK::EventId::CURRENT_VALUES_SENT_AND_CONTROL_TAKEN, processAccessibleParameters(), processControlEnded(), processControlReleased(), processControlReleasedBy(), processControlTakenBy(), processCurrentValuesSent(), and processCurrentValuesSentAndControlTaken().

Referenced by OMK::Iii::JointInteractorExtension::loadExtensionParameters(), and loadExtensionParameters().

{
  if( !_accessibleConnectorsListener )
  { 
    // The event listener is not already created => adds it
    _accessibleConnectorsListener = new Type::AccessibleParametersListEventListener
      ( *_owner, this, 
        &InteractorExtension::processAccessibleParameters, 
        EventId::ACCESSIBLE_PARAMETERS ) ;
    _currentValuesSentAndControlTakenListener = new ControlTakenEventListener
      ( *_owner, this, 
         &InteractorExtension::processCurrentValuesSentAndControlTaken, 
        EventId::CURRENT_VALUES_SENT_AND_CONTROL_TAKEN ) ;
    _controlReleasedListener = new ControlEndedEventListener
      (  *_owner, this, 
         &InteractorExtension::processControlReleased,
         EventId::CONTROL_RELEASED ) ;
    _controlEndedListener = new ControlEndedEventListener
      ( *_owner, this, 
        &InteractorExtension::processControlEnded, 
        EventId::CONTROL_ENDED ) ;
    _controlTakenByListener = new ControlUpdatedEventListener
      ( *_owner, this, 
        &InteractorExtension::processControlTakenBy, 
        EventId::CONTROL_TAKEN_BY ) ;
    _controlReleasedByListener = new ControlUpdatedEventListener
      ( *_owner, this, 
        &InteractorExtension::processControlReleasedBy, 
        EventId::CONTROL_RELEASED_BY ) ;
    _currentValuesSentListener = new EventListenerCallBack< InteractorExtension >
      ( *_owner, this, 
        &InteractorExtension::processCurrentValuesSent, 
        EventId::CURRENT_VALUES_SENT ) ;
  }
}

void InteractorExtension::startSessionWith

(

const Name &

interactiveObject

)

[virtual]

Method to start a new session.

Parameters:

[in]

interactiveObject

The id of the interactive object the interactor wants to interact with.

With createSession method creates a new session and adds it to the map of sessions, then starts the dialog with the interactive object by asking its parameters.

This method is a virtual and can be defined in sons. The son must create create a new session, add it to the map. The son chooses the type and the behavior of the session to be created.

If you only want to use an other type of session instead of the standard one, you should overwrite the protected method createSession instead of this one.

Definition at line 179 of file OMKInteractorExtension.cpp.

References OMK::ExtensionT< SimulatedObjectType >::_owner, _sessionsPrm, createSession(), OMK::debugMsg(), OMK::Iii::getAccessibleParameters(), OMK::Iii::SessionPrm::getInteractiveObject(), getSessionWith(), OMK_DEBUG_III, and OMTRACEID.

Referenced by OMK::Iii::JointInteractorExtension::startRetroPropagation().

{ 
  if( !getSessionWith( interactiveObject ) )
  {
    OMTRACEID( OMK_DEBUG_III, "The interactor " <<  OMK::debugMsg( this, _owner ) << " starts session with \"" <<  interactiveObject << "\"") ;
    // Add a new session
    SessionPrm* session = createSession( interactiveObject ) ;
    if( session )
    {
      _sessionsPrm.insert( std::pair< const Name, SessionPrm* >( session->getInteractiveObject(), session ) ) ;
      // Asks for parameters => init will be call if the interactive object answers with the list of its parameters
      (*session).c( getAccessibleParameters ) ;
    }
  }
  else
  {
    OMTRACEID( OMK_DEBUG_III, "The interactor " <<  OMK::debugMsg( this, _owner )
               << " doesn't need to start a session with interactive object \"" <<  interactiveObject << "\", session already exists" ) ;
  }
}

void InteractorExtension::closeSessionWith

(

const Name &

interactiveObject

)

[virtual]

Method to close a session.

Parameters:

[in]

interactiveObject

The id of the interactive object in interaction.

Releases the control and destroys the session parameters.

Definition at line 208 of file OMKInteractorExtension.cpp.

References OMK::ExtensionT< SimulatedObjectType >::_owner, _sessionsPrm, OMK::Iii::controlRelease(), OMK::debugMsg(), getSessionWith(), OMK_DEBUG_III, and OMTRACEID.

Referenced by closeAllSessions().

{ 
  SessionPrm* session = getSessionWith( interactiveObject ) ;
  if( session )
  {
    OMTRACEID( OMK_DEBUG_III, "The interactor " <<  OMK::debugMsg( this, _owner ) << " stops session with " <<  interactiveObject ) ;
    // Releases the interactive object, erases session from map, and destroys it
    (*session).c( controlRelease ) ;
    _sessionsPrm.erase( interactiveObject ) ;
    delete session ;
  }
}

SessionPrm * InteractorExtension::getSessionWith

(

const Name &

interactiveObject

)

Method to retrieve the session associated with the interactive object.

Parameters:

[in]

interactiveObject

The id of the interactive object in interaction.

Returns:

The session parameters associated to the interaction with the interactive object or null if the interactor is not in interaction with this object id.

Definition at line 231 of file OMKInteractorExtension.cpp.

References _sessionsPrm.

Referenced by closeSessionWith(), processAccessibleParameters(), OMK::Iii::InteractorOutputT< PrmType, ModelType >::processSetValue(), OMK::Iii::JointInteractorExtension::startRetroPropagation(), startSessionWith(), and OMK::Iii::JointInteractorExtension::stopRetroPropagation().

{
  SessionsMap::const_iterator session = _sessionsPrm.find( interactiveObject ) ;
  return ( session != _sessionsPrm.end() ) ? session->second : 0 ;
}

void InteractorExtension::closeAllSessions

(

)

Method to close all the sessions.

Releases the control and destroys the all the sessions parameters.

Definition at line 222 of file OMKInteractorExtension.cpp.

References _sessionsPrm, and closeSessionWith().

Referenced by ~InteractorExtension().

{
  for ( SessionsMap::const_iterator i = _sessionsPrm.begin() ; i != _sessionsPrm.end() ; i = _sessionsPrm.begin() )
  {
    closeSessionWith( i->first ) ;
  }
}

SessionPrm * InteractorExtension::createSession

(

const Name &

interactiveObject

)

[protected, virtual]

Method to create a new session.

Parameters:

[in]

interactiveObject

The id of the interactive object the interactor wants to interact with.

Creates a new standard session parameters.

This method is a virtual and can be defined in sons. The son can create a new type of session.

Definition at line 201 of file OMKInteractorExtension.cpp.

References OMK::Iii::SessionPrm::create().

Referenced by startSessionWith().

{
  // return the standard session (can be nul if interactiveObject is not a simulated object)
  return SessionPrm::create( this, interactiveObject ) ;
}

ExtensibleSimulatedObject* OMK::Iii::InteractorExtension::getInteractor

(

)

[inline]

Definition at line 129 of file OMKInteractorExtension.h.

Referenced by OMK::Iii::InteractorOutput::create(), OMK::Iii::SessionPrm::selfControlRelease(), OMK::Iii::SessionPrm::selfControlTakeOverAndGetCurrentValues(), and OMK::Iii::SessionPrm::selfGetAccessibleParameters().

{ return _owner ; }

OMK::Type::AccessLevel OMK::Iii::InteractorExtension::getAccessLevel

(

)

const [inline]

Get the access level of the interactor.

Returns:

the access level of the interactor, see _access.

Definition at line 132 of file OMKInteractorExtension.h.

Referenced by OMK::Iii::SessionPrm::selfControlTakeOverAndGetCurrentValues(), and OMK::Iii::SessionPrm::selfGetAccessibleParameters().

{ return _access._level ; }

void OMK::Iii::InteractorExtension::setAccessLevel

(

OMK::Type::AccessLevel

level = 0

)

[inline]

Set the access level of the interactor.

Parameters:

[in]

level

See _access.

Definition at line 135 of file OMKInteractorExtension.h.

{ _access._level = level ; }

const OMK::Name& OMK::Iii::InteractorExtension::getGroup

(

)

const [inline]

Get the group name of the interactor.

Returns:

the group name of the interactor, see _access.

Definition at line 138 of file OMKInteractorExtension.h.

Referenced by OMK::Iii::SessionPrm::selfControlTakeOverAndGetCurrentValues(), and OMK::Iii::SessionPrm::selfGetAccessibleParameters().

{ return _access._groupName ; }

void OMK::Iii::InteractorExtension::setGroup

(

const OMK::Name &

name

)

[inline]

Set the group name of the interactor.

Parameters:

[in]

name

See _access.

Definition at line 141 of file OMKInteractorExtension.h.

{ _access._groupName = name ; }

const OMK::Type::AccessGroup& OMK::Iii::InteractorExtension::getAccessGroup

(

)

const [inline]

Definition at line 143 of file OMKInteractorExtension.h.

{ return _access ; }

bool InteractorExtension::processAccessibleParameters

(

Type::AccessibleParametersListEvent *

event

)

[protected, virtual]

Process the "available_connectors" event.

This event is a answer coming from the interactive object to question of the associated. This answer is a valued event with the list of available connectors.

This message is the first in the protocol, it initializes the dialog between the interactor and an interactive object. The session parameters are initialized here, see SessionPrm::init and "available connectors".

Definition at line 238 of file OMKInteractorExtension.cpp.

References _interactorOutputs, OMK::ExtensionT< SimulatedObjectType >::_owner, OMK::EventId::ACCESSIBLE_PARAMETERS, OMK::debugMsg(), getSessionWith(), OMK::Iii::SessionPrm::init(), OMASSERTM, OMK_DEBUG_III, and OMTRACEID.

Referenced by startInteractor().

{
  OMASSERTM( event->eventId == EventId::ACCESSIBLE_PARAMETERS, "The event must be \"" << EventId::ACCESSIBLE_PARAMETERS << "\" but is \"" << event->eventId << "\"" ) ;
  SessionPrm* session = getSessionWith( event->sender ) ;
  OMTRACEID( OMK_DEBUG_III, "The interactor " <<  OMK::debugMsg( this, _owner ) << " received the connectors list from \"" << event->sender << "\"" << ( session ? "" : " but it is not interacting with it !" ) ) ;
  if( session )
  {
    session->init( _interactorOutputs, event->value ) ;
  }
  return session != 0 ;
}

virtual bool OMK::Iii::InteractorExtension::processCurrentValuesSentAndControlTaken

(

Type::ControlTakenEvent *

event

)

[protected, virtual]

Process the "control_taken" event.

This event is a answer coming form the interactive object to the "control take over" action. This answer is a valued event with the list of actually controlled connectors.

This message is a feed back for the interactor to know which connectors it is controlling actually. The default behavior for this message processing is to update the list of outputs which control connectors. This method should be overwritten to change this behavior, see "control taken".

Referenced by startInteractor().

virtual bool OMK::Iii::InteractorExtension::processControlReleased

(

Type::ControlReleasedEvent *

event

)

[protected, virtual]

Process the "control_released" event.

This event is sent by the interactive object to the interactor when it has finished to process a "control_release" event previously sent by the interactor. This event acts as a acknowledgment for the event "control_release". This event contains id of the connector that is no more controlled. See "control ended".

Referenced by startInteractor().

virtual bool OMK::Iii::InteractorExtension::processControlEnded

(

Type::ControlEndedEvent *

event

)

[protected, virtual]

Process the "control_ended" event.

This event is an information coming from the interactive object. This information is a valued event with the id of the connector that is no more controlled.

This message is a feed back for the interactor to know which connectors it is controlling actually. The default behavior for this message processing is to update the list of outputs which control connectors. This method should be overwritten to change this behavior, see "control ended".

Referenced by startInteractor().

virtual bool OMK::Iii::InteractorExtension::processControlTakenBy

(

Type::ControlUpdatedEvent *

event

)

[protected, virtual]

Referenced by startInteractor().

virtual bool OMK::Iii::InteractorExtension::processControlReleasedBy

(

Type::ControlUpdatedEvent *

event

)

[protected, virtual]

Referenced by startInteractor().

bool InteractorExtension::processCurrentValuesSent

(

Event *

event

)

[protected, virtual]

Process the "current_values_sent" event.

Should be overwritten by sons classes. Do nothing by default.

Definition at line 296 of file OMKInteractorExtension.cpp.

References OMK::EventId::CURRENT_VALUES_SENT, OMK::Event::eventId, and OMASSERTM.

Referenced by startInteractor().

{
  OMASSERTM( event->eventId == EventId::CURRENT_VALUES_SENT, "The event must be \"" << EventId::CURRENT_VALUES_SENT << "\" but is \"" << event->eventId << "\"" ) ;
  return true ; 
}

void InteractorExtension::addInteractorOutput

(

InteractorOutput *

interactorOutput

)

Method to add output connectors.

The output connector will be added the map of output connectors.

Definition at line 314 of file OMKInteractorExtension.cpp.

References _interactorOutputs, OMK::Iii::InteractorOutput::category(), and OMK::Iii::InteractorOutput::type().

Referenced by OMK::Iii::InteractorOutput::create().

{
  _interactorOutputs.insert( std::pair< InteractorOutputsIndex, InteractorOutput* >( InteractorOutputsIndex( interactorOutput->category(), interactorOutput->type() ), interactorOutput ) ) ;
}

---

Member Data Documentation

SessionsMap OMK::Iii::InteractorExtension::_sessionsPrm [protected]

Map of session parameters.

This map stores the session parameters for each interactive object in interaction with the associated interactor. It is indexed by interactive object id.

Definition at line 126 of file OMKInteractorExtension.h.

Referenced by closeAllSessions(), closeSessionWith(), getSessionWith(), and startSessionWith().

OMK::Type::AccessGroup OMK::Iii::InteractorExtension::_access [protected]

Level access and group of the interactor.

This value indicates the access level to the parameters. Only interactor with an appropriate access level will be able to see the parameters. A parameter with an access level of 10 will be seen only by interactors of level 10 or more, with an access level of 1, it will be seen by any interactors.
This level can be change with setAccessLevel and read by getAccessLevel. This name indicates the group of the interactor. Only interactors with an appropriate group and access level will be able to see the parameters. This group can be change with setGroup and read by getGroup.

Definition at line 156 of file OMKInteractorExtension.h.

Referenced by OMK::Iii::JointInteractorExtension::JointInteractorExtension(), OMK::Iii::JointInteractorExtension::loadExtensionParameters(), and loadExtensionParameters().

EventListener* OMK::Iii::InteractorExtension::_accessibleConnectorsListener [protected]

Pointer to aggregate the "accessible connectors" listener.

Definition at line 161 of file OMKInteractorExtension.h.

Referenced by startInteractor(), and ~InteractorExtension().

EventListener* OMK::Iii::InteractorExtension::_currentValuesSentAndControlTakenListener [protected]

Pointer to aggregate the "control taken and get current values sent" listener.

Definition at line 163 of file OMKInteractorExtension.h.

Referenced by startInteractor(), and ~InteractorExtension().

EventListener* OMK::Iii::InteractorExtension::_controlReleasedListener [protected]

Pointer to aggregate the "control released" listener.

Definition at line 165 of file OMKInteractorExtension.h.

Referenced by startInteractor(), and ~InteractorExtension().

EventListener* OMK::Iii::InteractorExtension::_controlEndedListener [protected]

Pointer to aggregate the "control ended" listener.

Definition at line 167 of file OMKInteractorExtension.h.

Referenced by startInteractor(), and ~InteractorExtension().

EventListener* OMK::Iii::InteractorExtension::_controlTakenByListener [protected]

Pointer to aggregate the "control taken by" listener.

Definition at line 169 of file OMKInteractorExtension.h.

Referenced by startInteractor(), and ~InteractorExtension().

EventListener* OMK::Iii::InteractorExtension::_controlReleasedByListener [protected]

Pointer to aggregate the "control released by" listener.

Definition at line 171 of file OMKInteractorExtension.h.

Referenced by startInteractor(), and ~InteractorExtension().

EventListener* OMK::Iii::InteractorExtension::_currentValuesSentListener [protected]

Pointer to aggregate the "current values sent" listener.

Definition at line 173 of file OMKInteractorExtension.h.

Referenced by startInteractor(), and ~InteractorExtension().

InteractorOutputsMap OMK::Iii::InteractorExtension::_interactorOutputs [protected]

Output connectors map.

Definition at line 224 of file OMKInteractorExtension.h.

Referenced by addInteractorOutput(), processAccessibleParameters(), and ~InteractorExtension().

---