OMK::Iii::SharedConnectorT< Type > Class Template Reference
[Interactive object]

The implementation class for shared connectors. More...

#include <OMKConnectors.h>

Inheritance diagram for OMK::Iii::SharedConnectorT< Type >:

[legend]Collaboration diagram for OMK::Iii::SharedConnectorT< Type >:

[legend]List of all members.

Public Types
typedef std::map< const Name, InputNT * >	MapInput
	Type for map of inputs.
Public Member Functions
Redefined interface.
virtual bool	isConnected (const Name &interactor) const
	Returns if the interactor is connected or not.
virtual bool	preConnect (const Name &interactor, const OMK::Type::AccessGroupLevel &freezeLevel, OMK::Type::AccessLevel tool)
	Connection method.
virtual bool	connect (const Name &interactor, const Name &outputName)
virtual void	disconnect (const Name &interactor)
	Disconnection method.
virtual void	disconnect ()
	Disconnection method.
virtual void	updateParameter () const
	Update method.
virtual void	sendValue (const Name &receiver) const
	Sending the current value.
Protected Attributes
MapInput	_inputs
	The pointer on the input to get the value from the interactor.
IAttributeBaseT< Type > *	_attribute
	The attribute interface.
IConvertorT< Type, std::vector< Type > > *	_convertor
	The convertor from inputs to the attribute.
Private Member Functions
	DECLARE_TEMPLATE_CONNECTOR_FACTORY (SharedConnectorT, Type)

---

Detailed Description

template<typename Type>
class OMK::Iii::SharedConnectorT< Type >

The implementation class for shared connectors.

Date:

2006-10-12

Author:

Beno� Chanclou

This connector allows the connection of several interactor. It is a part of the interaction protocol.
This connector must be associated with a Convertor to work properly.

This connector is a template class, the parameter is:

• Type, it is the type of the value associated to the parameter and it must be a son of OMKType.

To use it see Create connectors.

Definition at line 165 of file OMKConnectors.h.

---

Member Typedef Documentation

template<typename Type>

typedef std::map< const Name, InputNT* > OMK::Iii::SharedConnectorT< Type >::MapInput

Type for map of inputs.

Definition at line 170 of file OMKConnectors.h.

---

Member Function Documentation

template<typename Type>

OMK::Iii::SharedConnectorT< Type >::DECLARE_TEMPLATE_CONNECTOR_FACTORY	(	SharedConnectorT< Type >	,
		Type
	)			[private]

template<typename T>

bool OMK::Iii::SharedConnectorT< T >::isConnected

(

const Name &

interactor

)

const [virtual]

Returns if the interactor is connected or not.

See IConnector::isConnected.

Implements OMK::Iii::IConnector.

Definition at line 214 of file OMKConnectors.inl.

References OMK::Iii::SharedConnectorT< Type >::_inputs.

{
  typename MapInput::const_iterator input = _inputs.find( interactor ) ;
  return input != _inputs.end() ;
}

template<typename Type>

virtual bool OMK::Iii::SharedConnectorT< Type >::preConnect	(	const Name &	interactor,
		const OMK::Type::AccessGroupLevel &	freezeLevel,
		OMK::Type::AccessLevel	tool
	)			[virtual]

Connection method.

This method creates an input in its associated interactive object and connects it to the output of the interactor.
The name of the created input is the concatenation of the iterator name and its output.
See IConnector::connect.

Implements OMK::Iii::IConnector.

template<typename T>

bool OMK::Iii::SharedConnectorT< T >::connect	(	const Name &	interactor,
		const Name &	outputName
	)			[virtual]

Implements OMK::Iii::IConnector.

Definition at line 237 of file OMKConnectors.inl.

References OMK::Iii::SharedConnectorT< Type >::_attribute, OMK::Iii::IConnector::_id, OMK::Iii::SharedConnectorT< Type >::_inputs, OMK::Iii::IConnector::_owner, OMK::Iii::IConnector::_toolsOnStandby, OMK::InputNT::connect(), OMK::IAttribute::createInput(), OMK::debugMsg(), OMK::SimulatedObject::deleteInput(), OMK::Name::getString(), OMK_DEBUG_III, and OMTRACEID.

{
  bool ok = false ;
  Name inputName ;
  InputNT* input = 0 ;
  std::list< Name >::iterator onStandby = std::find( _toolsOnStandby.begin(), _toolsOnStandby.end(), interactor ) ;
  if( onStandby != _toolsOnStandby.end() )
  {
    // creates the name's input
    inputName = interactor.getString() + outputName.getString() ;
    // creates the input in the interactive object
    input = _attribute->createInput( inputName ) ;
    // connects it to the interactor output
    ok = input->connect( interactor, outputName ) ; 
  }
  if( ok )
  { // successful connection => add the input to the list
    _inputs.insert( std::pair< const Name, InputNT* >( interactor, input ) ) ;
    _toolsOnStandby.erase( onStandby ) ;
  }
  else
  { // Unsuccessful connection => delete the input
    OMTRACEID( OMK_DEBUG_III, ":-( Error in SharedConnectorT< \"" << _id.getString() 
        << "\" >:: connect for the " << OMK::debugMsg( _owner ) << std::endl
        << ">>> The interactor \"" << interactor.getString() << "\" cannot be connected !" ) ;
    if( !input ) 
    {
      _owner->deleteInput( inputName ) ;
    }
  }
  return ok ;
}

template<typename T>

void OMK::Iii::SharedConnectorT< T >::disconnect

(

const Name &

interactor

)

[virtual]

Disconnection method.

Disconnects the input and destroys it.
See IConnector::disconnect( const Name& interactor ).

Implements OMK::Iii::IConnector.

Definition at line 271 of file OMKConnectors.inl.

References OMK::Iii::IConnector::_accessRule, OMK::Iii::IConnector::_id, OMK::Iii::SharedConnectorT< Type >::_inputs, OMK::Iii::IConnector::_owner, OMK::Iii::IConnector::_toolsInUse, OMK::Iii::IConnector::_toolsOnStandby, OMK::debugMsg(), OMK::SimulatedObject::deleteInput(), OMK::Name::getString(), OMK_DEBUG_III, OMTRACEID, OMK::Iii::IAccessRule::resetCurrentLevel(), OMK::Iii::IConnector::SendControlReleased(), and OMK::Iii::IConnector::SendControlReleasedBy().

{
  // Only this iterator will be disconnected => find it
  std::list< Name >::iterator inUse = std::find( _toolsInUse.begin(), _toolsInUse.end(), interactor ) ;
  if( inUse != _toolsInUse.end() ) 
  {
    // Inform interactor
    SendControlReleased( interactor ) ;
    // Clean the lists => no more interactor in them
    _toolsInUse.erase( inUse ) ;
    std::list< Name >::iterator onStanby = std::find( _toolsOnStandby.begin(), _toolsOnStandby.end(), interactor ) ;
    if( onStanby != _toolsOnStandby.end() ) _toolsOnStandby.erase( onStanby ) ;
    // Informs every other interactor in use or standby
    SendControlReleasedBy( interactor ) ;
    // find the input connected to the interactor, disconnects and deletes it
    typename MapInput::iterator input = _inputs.find( interactor ) ;
    if( input != _inputs.end() )
    {
      input->second->disconnect() ; 
      _owner->deleteInput( input->second->getName() ) ;
      _inputs.erase( input ) ;
      if( _inputs.empty() ) _accessRule->resetCurrentLevel() ; // unfreeze if necessary
    }
  }
  else
  {
    OMTRACEID( OMK_DEBUG_III, ":-( Error in SharedConnectorT< \"" << _id.getString() 
             << "\" >:: disconnect for the " << OMK::debugMsg( _owner ) << std::endl
             << ">>> The interactor \"" << interactor.getString() << "\" is not one of those which are connected !" ) ;
  }
}

template<typename T>

void OMK::Iii::SharedConnectorT< T >::disconnect

(

)

[virtual]

Disconnection method.

Disconnects all the inputs and destroys them.
See IConnector::disconnect().

Implements OMK::Iii::IConnector.

Definition at line 304 of file OMKConnectors.inl.

References OMK::Iii::IConnector::_accessRule, OMK::Iii::SharedConnectorT< Type >::_inputs, OMK::Iii::IConnector::_owner, OMK::Iii::IConnector::_toolsInUse, OMK::Iii::IConnector::_toolsOnStandby, OMK::SimulatedObject::deleteInput(), OMK::Iii::IAccessRule::resetCurrentLevel(), and OMK::Iii::IConnector::SendControlEnded().

{
  // Inform every connected interactor
  for ( std::list< Name >::const_iterator interactor = _toolsInUse.begin() ; interactor !=  _toolsInUse.end() ; ++interactor )
  {
    SendControlEnded( *interactor ) ;
  }
  // All the iterators will be disconnected
  // disconnects and deletes all the inputs and clear the map
  for ( typename MapInput::const_iterator i = _inputs.begin() ; i !=  _inputs.end() ; ++i )
  {
    i->second->disconnect() ; 
    _owner->deleteInput( i->second->getName() ) ;
  }
  _inputs.clear() ;
  _toolsOnStandby.clear() ;
  _toolsInUse.clear() ;
  _accessRule->resetCurrentLevel() ; // unfreeze if necessary
}

template<typename T>

void OMK::Iii::SharedConnectorT< T >::updateParameter

(

)

const [virtual]

Update method.

The method gets the values read from the associated inputs and gives them to the object which updates its parameter.
See IConnector::updateParameter.

Implements OMK::Iii::IConnector.

Definition at line 325 of file OMKConnectors.inl.

References OMK::Iii::SharedConnectorT< Type >::_attribute, OMK::Iii::SharedConnectorT< Type >::_convertor, OMK::Iii::SharedConnectorT< Type >::_inputs, OMK::Iii::IConvertorT< TypeOut, TypeIn >::convert(), OMK::IAccessorT< T >::get(), OMK::IAttributeBaseT< PrmType >::getValueFromInput(), and OMK::IAccessorT< T >::set().

{ 
  // if at least one input is connected, it updates the parameter
  if( _inputs.size() )
  {
    // Creating a vector with the appropriate size
    std::vector< T > values( _inputs.size() ) ;
    // Retrieve the value in the inputs
    int j = 0 ;
    for ( typename MapInput::const_iterator i = _inputs.begin() ; 
          i !=  _inputs.end() ; 
          ++i, j++ ) 
    {
      _attribute->getValueFromInput( values[j], i->second ) ;
    }
    // Update the parameter
    if( _convertor )
    {
      T valueOut = _attribute->get() ;
      _convertor->convert( valueOut, values ) ;
      _attribute->set( valueOut ) ; 
    }
  }
}

template<typename T>

void OMK::Iii::SharedConnectorT< T >::sendValue

(

const Name &

receiver

)

const [virtual]

Sending the current value.

Call by EventInteractorListener::processGetParameters to send the current value of the parameter. See the protocol

Implements OMK::Iii::IConnector.

Definition at line 351 of file OMKConnectors.inl.

References OMK::Iii::SharedConnectorT< Type >::_attribute, OMK::Iii::IConnector::_id, OMK::EventId::CURRENT_VALUE, and OMK::IAttribute::sendIdAndValue().

{
  _attribute->sendIdAndValue( receiver, EventId::CURRENT_VALUE, _id ) ;
}

---

Member Data Documentation

template<typename Type>

MapInput OMK::Iii::SharedConnectorT< Type >::_inputs [protected]

The pointer on the input to get the value from the interactor.

Definition at line 204 of file OMKConnectors.h.

Referenced by OMK::Iii::SharedConnectorT< Type >::connect(), OMK::Iii::SharedConnectorT< Type >::disconnect(), OMK::Iii::SharedConnectorT< Type >::isConnected(), and OMK::Iii::SharedConnectorT< Type >::updateParameter().

template<typename Type>

IAttributeBaseT< Type >* OMK::Iii::SharedConnectorT< Type >::_attribute [protected]

The attribute interface.

Definition at line 206 of file OMKConnectors.h.

Referenced by OMK::Iii::SharedConnectorT< Type >::connect(), OMK::Iii::SharedConnectorT< Type >::sendValue(), and OMK::Iii::SharedConnectorT< Type >::updateParameter().

template<typename Type>

IConvertorT< Type, std::vector< Type > >* OMK::Iii::SharedConnectorT< Type >::_convertor [protected]

The convertor from inputs to the attribute.

Definition at line 208 of file OMKConnectors.h.

Referenced by OMK::Iii::SharedConnectorT< Type >::updateParameter().

---