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

The implementation class for simple connectors. More...

#include <OMKConnectors.h>

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

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

[legend]List of all members.

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 &freeze, 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
InputNT *	_input
	The pointer on the input to get the value from the interactor.
IAttributeBaseT< Type > *	_attribute
	The attribute interface.
IConvertorT< Type, Type > *	_convertor
	The optionnal convertor from input to the attribute.
Private Member Functions
	DECLARE_TEMPLATE_CONNECTOR_FACTORY (SimpleConnectorT, Type)

---

Detailed Description

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

The implementation class for simple connectors.

Date:

2006-10-12

Author:

Beno� Chanclou

This connector allows the connection of only one interactor at the same time. It is a part of the interaction protocol.

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 101 of file OMKConnectors.h.

---

Member Function Documentation

template<typename Type>

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

template<typename T>

bool OMK::Iii::SimpleConnectorT< 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 67 of file OMKConnectors.inl.

References OMK::Iii::SimpleConnectorT< Type >::_input, OMK::InputNT::getConnectedOutput(), OMK::SimulatedObject::getName(), and OMK::KernelAttribute::getOwner().

Referenced by OMK::Iii::SimpleConnectorT< Type >::disconnect().

{
  return _input 
      && _input->getConnectedOutput() 
      && _input->getConnectedOutput()->getOwner().getName() == interactor ;
}

template<typename Type>

virtual bool OMK::Iii::SimpleConnectorT< Type >::preConnect	(	const Name &	interactor,
		const OMK::Type::AccessGroupLevel &	freeze,
		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.

Reimplemented in OMK::Iii::AssociatedConnectorT< Type >.

template<typename T>

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

Implements OMK::Iii::IConnector.

Definition at line 95 of file OMKConnectors.inl.

References OMK::Iii::SimpleConnectorT< Type >::_attribute, OMK::Iii::IConnector::_id, OMK::Iii::SimpleConnectorT< Type >::_input, OMK::Iii::IConnector::_owner, OMK::Iii::IConnector::_toolsOnStandby, OMK::InputNT::connect(), OMK::IAttribute::createInput(), OMK::debugMsg(), OMK::Name::getString(), OMASSERT, OMK_DEBUG_III, and OMTRACEID.

{
  bool ok = false ;
  Name inputName ;
  if( std::find( _toolsOnStandby.begin(), _toolsOnStandby.end(), interactor ) != _toolsOnStandby.end() )
  {
    // preconditions
    OMASSERT( !_input && "The connector must be disconnected" ) ;
    // 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 && _input->connect( interactor, outputName ) ; 
  }
  if( ok )
  { // The interactor is no more waiting list
    _toolsOnStandby.clear() ;
  }
  else
  { // Unsuccessful connection => delete the input
    OMTRACEID( OMK_DEBUG_III, ":-( Error in SimpleConnectorT< \"" << _id 
        << "\" >:: connect for the " << OMK::debugMsg( _owner ) << std::endl
        << ">>> The interactor \"" << interactor << "\" cannot be connected !" ) ;
    _owner->deleteInput( inputName ) ;
    _input = 0 ;
  }
  return ok ;
}

template<typename T>

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

(

const Name &

interactor

)

[virtual]

Disconnection method.

Disconnects the input and destroys it. An assertion is made with the interactor name.
See IConnector::disconnect( const Name& interactor ).

Implements OMK::Iii::IConnector.

Definition at line 126 of file OMKConnectors.inl.

References OMK::Iii::IConnector::_id, OMK::Iii::IConnector::_owner, OMK::debugMsg(), OMK::Name::getString(), OMK::Iii::SimpleConnectorT< Type >::isConnected(), OMK_DEBUG_III, and OMTRACEID.

{
  if( isConnected( interactor ) )
  {
    SimpleConnectorT< T >::disconnect() ;
  }
  else
  {
    OMTRACEID( OMK_DEBUG_III, ":-( Error in SimpleConnectorT< \"" << _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::SimpleConnectorT< T >::disconnect

(

)

[virtual]

Disconnection method.

Disconnects the input and destroys it.
See IConnector::disconnect().

Implements OMK::Iii::IConnector.

Definition at line 141 of file OMKConnectors.inl.

References OMK::Iii::IConnector::_accessRule, OMK::Iii::SimpleConnectorT< Type >::_input, OMK::Iii::IConnector::_owner, OMK::Iii::IConnector::_toolsInUse, OMK::Iii::IConnector::_toolsOnStandby, OMK::SimulatedObject::deleteInput(), OMK::InputNT::disconnect(), OMK::KernelAttribute::getName(), OMK::Iii::IAccessRule::resetCurrentLevel(), and OMK::Iii::IConnector::SendControlEnded().

{
  // Must send a event to inform the old interactor it was disconnected
  if( !_toolsInUse.empty() )
  {
    SendControlEnded( *_toolsInUse.begin() ) ;
  }
  if( _input )
  {
    _input->disconnect() ; 
    _owner->deleteInput( _input->getName() ) ;
    _input = 0 ;
  }
  _toolsOnStandby.clear() ; // discard the possible waiting tool
  _toolsInUse.clear() ;
  _accessRule->resetCurrentLevel() ; // unfreeze if necessary
}

template<typename T>

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

(

)

const [virtual]

Update method.

The method gets the value read from the associated input and gives it to the owner which updates its parameter.
See IConnector::updateParameter.

Implements OMK::Iii::IConnector.

Definition at line 160 of file OMKConnectors.inl.

References OMK::Iii::SimpleConnectorT< Type >::_attribute, OMK::Iii::SimpleConnectorT< Type >::_convertor, OMK::Iii::SimpleConnectorT< Type >::_input, OMK::IAccessorT< T >::get(), OMK::IAttributeBaseT< PrmType >::getValueFromInput(), and OMK::IAccessorT< T >::set().

{ // if it is connected, it updates the parameter
  if( _input ) 
  {
    // Update the parameter
    if( _convertor )
    { // Through the convertor
      T valueOut = _attribute->get() ;
      T valueIn ;
      _attribute->getValueFromInput( valueIn, _input ) ;
      _convertor->convert( valueOut, valueIn ) ;
      _attribute->set( valueOut ) ; 
    }
    else
    { // directly
      _attribute->getValueFromInput( _input ) ; 
    }
  }
}

template<typename T>

void OMK::Iii::SimpleConnectorT< 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 181 of file OMKConnectors.inl.

References OMK::Iii::SimpleConnectorT< 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>

InputNT* OMK::Iii::SimpleConnectorT< Type >::_input [protected]

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

Definition at line 141 of file OMKConnectors.h.

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

template<typename Type>

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

The attribute interface.

Definition at line 143 of file OMKConnectors.h.

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

template<typename Type>

IConvertorT< Type, Type >* OMK::Iii::SimpleConnectorT< Type >::_convertor [protected]

The optionnal convertor from input to the attribute.

Definition at line 145 of file OMKConnectors.h.

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

---