OMKAttribute.inl

Go to the documentation of this file.

/************************************************************************/
/* This file is part of openMask(c) INRIA, CNRS, Universite de Rennes 1 */
/* 1993-2002, thereinafter the Software                                 */
/*                                                                      */
/* The Software has been developped within the Siames Project.          */
/* INRIA, the University of Rennes 1 and CNRS jointly hold intellectual */
/* property rights                                                      */
/*                                                                      */
/* The Software has been registered with the Agence pour la Protection  */
/* des Programmes (APP) under registration number                       */
/* IDDN.FR.001.510008.00.S.P.2001.000.41200                             */
/*                                                                      */
/* This file may be distributed under the terms of the Q Public License */
/* version 1.0 as defined by Trolltech AS of Norway and appearing in    */
/* the file LICENSE.QPL included in the packaging of this file.         */
/*                                                                      */
/* Licensees holding valid specific licenses issued by INRIA, CNRS or   */
/* Universite Rennes 1 for the software may use this file in            */
/* acordance with that specific license                                 */
/************************************************************************/
                
#if !defined OMK_ATTRIBUTE_INL
#define OMK_ATTRIBUTE_INL

#include "OMKSimpleTypeT.inl"
#include "OMKInput.h"
#include "OMKOutput.h"
#include "OMKParametersAccessor.inl"
#include "OMKValuedEvent.h"
#include "OMKValuedEventListenerCallBack.h"
#include "OMKExtensibleSimulatedObject.h"


//=================================================================
// IAttributeBaseT
//=================================================================
//-----------------------------------------------------------------
template< typename PrmType >
OMK::IAttributeBaseT< PrmType >::IAttributeBaseT( const Name& id ) 
: IAttribute( id )
{
}
//-----------------------------------------------------------------

template< typename PrmType >
OMK::IAttributeBaseT< PrmType >::~IAttributeBaseT() 
{
}
//-----------------------------------------------------------------

template< typename PrmType >
bool OMK::IAttributeBaseT< PrmType >::loadParameters( const OMK::ConfigurationParameterDescriptor * node, 
                                              const std::string* aliasName ) 
{
  // Try to retrieve a value, ignores if cannot
  if( OMK::ParametersAccessor::get( node, aliasName ? *aliasName : getId().getCString(), *this ) )
  {
    std::ostringstream msg ; 
                msg << "Information for " << OMK::debugMsg( this ) << std::endl
      << ">>> :-) Initial value is :" 
      << std::endl << this->get() ;
    OMTRACEID( OMK_DEBUG_OMK_ATTR, msg.str() ) ;
  }

  return IAttribute::loadParameters( node, aliasName ) ;
}
//-----------------------------------------------------------------


//=================================================================
// IAttributeBaseT
//=================================================================
//-----------------------------------------------------------------
template< typename PrmType, typename ModelType, typename AccessorType >
OMK::IAttributeT< PrmType, ModelType, AccessorType >::IAttributeT( const Name& id, const AccessorType& init ) 
: OMK::IAttributeBaseT< PrmType >( id ),
  _accessor( init ),
  _input( 0 ),
  _output( 0 )
{
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
OMK::IAttributeT< PrmType, ModelType, AccessorType >::~IAttributeT() 
{
  // disconnect and delete the associated input
  if( _input )
  {
    _input->disconnect() ; 
    this->_owner->deleteInput( _input->getName() ) ;
    _input = 0 ;
  }
  // The output cannot be delete it stay alive but is no more updated
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
void OMK::IAttributeT< PrmType, ModelType, AccessorType >::activateSetByEvent() 
{
  if( !this->_currentValueListener )
  {
    this->_currentValueListener = new IdAndValueEventListener
        ( * this->_owner, this, 
        (typename IdAndValueEventListener::CallBackFct)&OMK::IAttributeT< PrmType, ModelType, AccessorType >::processSetValue, 
        EventId::CURRENT_ATTRIBUTE_VALUE ) ;
    OMTRACEID( OMK_DEBUG_OMK_ATTR, 
      "Information for " << OMK::debugMsg( this ) << std::endl
      << ">>> :-) Set by event is activated!" ) ;
  }
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
void OMK::IAttributeT< PrmType, ModelType, AccessorType >::activateSetByEventOf()
{
  if( !this->_currentValueOfListener )
  {
    this->_currentValueOfListener = new ValuedEventListenerCallBack< OMK::IAttributeT< PrmType, ModelType, AccessorType >, ModelType >
      ( * this->_owner, this, 
        ( typename ValuedEventListenerCallBack< OMK::IAttributeT< PrmType, ModelType, AccessorType >, ModelType >::CallBackFct)&OMK::IAttributeT< PrmType, ModelType, AccessorType >::processSetValueOf, 
          this->_currentValueOfId ) ;
    OMTRACEID( OMK_DEBUG_OMK_ATTR, 
      "Information for " << OMK::debugMsg( this ) << std::endl
          << ">>> :-) Set by event \"" << this->_currentValueOfId.getCString() 
      << "\" is activated!" ) ;
  }
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
void OMK::IAttributeT< PrmType, ModelType, AccessorType >::createInput() 
{
  OMASSERTM( !_input, "There is already an input!" ) ;

  _input = &this->_owner->template addInput< ModelType >( getId() ) ;
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
OMK::InputNT* OMK::IAttributeT< PrmType, ModelType, AccessorType >::createInput( const Name& name ) 
{
  return &this->_owner->template addInput< ModelType >( name ) ;
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
void OMK::IAttributeT< PrmType, ModelType, AccessorType >::createOutput() 
{
  if( !_output )
  {
    _output = &this->_owner->template addOutput< ModelType >( getId() ) ;
  }
  setValueToOutput() ;
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
OMK::InputNT* OMK::IAttributeT< PrmType, ModelType, AccessorType >::getInput() 
{
  return _input ;
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
OMK::OutputNT* OMK::IAttributeT< PrmType, ModelType, AccessorType >::getOutput() 
{
  return _output ;
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
OMK::Input< ModelType >* OMK::IAttributeT< PrmType, ModelType, AccessorType >::getInputT() 
{
  return _input ;
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
OMK::Output< ModelType >* OMK::IAttributeT< PrmType, ModelType, AccessorType >::getOutputT() 
{
  return _output ;
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
void OMK::IAttributeT< PrmType, ModelType, AccessorType >::getValueFromInput() 
{
  if( _input && _input->getConnectedOutput() )
  {
    set( static_cast< const PrmType & >( _input->get() ) ) ;
  }
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
void OMK::IAttributeT< PrmType, ModelType, AccessorType >::getValueFromInput( OMK::InputNT* input ) 
{
  Input< ModelType >*typedInput = dynamic_cast< Input< ModelType >* >( input ) ;
  if( typedInput && typedInput->getConnectedOutput() )
  {
    set( static_cast< const PrmType & >( typedInput->get() ) ) ;
  }
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
void OMK::IAttributeT< PrmType, ModelType, AccessorType >::getValueFromInput( PrmType& value, OMK::InputNT* input, int deltaT ) const
{
  Input< ModelType >*typedInput = dynamic_cast< Input< ModelType >* >( input ) ;
  if( typedInput && typedInput->getConnectedOutput() ) 
  { 
    value = static_cast< const PrmType & >( typedInput->get( deltaT ) ) ;
  }
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
void OMK::IAttributeT< PrmType, ModelType, AccessorType >::setValueToOutput()
{
  if( _output )
  {
    _output->set( ModelType( get() ) ) ;
  }
}
//-----------------------------------------------------------------
template< typename PrmType, typename ModelType, typename AccessorType >
bool OMK::IAttributeT< PrmType, ModelType, AccessorType >::processSetValueOf( ValuedEvent< ModelType > *e ) 
{
  set( static_cast< const PrmType & >( e->value ) ) ;
  return true ;
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
bool OMK::IAttributeT< PrmType, ModelType, AccessorType >::processSetValue( IdAndValueEvent *e ) 
{
  bool ok = e && ( getId() == e->value.getValue().first ) ; 
  if( ok )
  {
    set( static_cast< const PrmType & >( e->value.getValue().second ) ) ;
  }
  return ok ;
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
void OMK::IAttributeT< PrmType, ModelType, AccessorType >::sendIdAndValue( const Name &receiver, const EventIdentifier& eventId, const Name &attributeId ) 
{
  this->_owner->sendValuedEvent( receiver, eventId, IdAndValueType( IdAndValuePrm( attributeId, ModelType( get() ) ) ) ) ;
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
void OMK::IAttributeT< PrmType, ModelType, AccessorType >::sendValue( const Name &receiver, const EventIdentifier& eventId ) 
{
  this->_owner->sendValuedEvent( receiver, eventId, ModelType( get() ) ) ;
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
void OMK::IAttributeT< PrmType, ModelType, AccessorType >::fireIdAndValue( const EventIdentifier& eventId, const Name &attributeId )
{
  this->_owner->fireValuedSignal( eventId, IdAndValueType( IdAndValuePrm( getId(), ModelType( get() ) ) ) ) ;
}
//-----------------------------------------------------------------

template< typename PrmType, typename ModelType, typename AccessorType >
void OMK::IAttributeT< PrmType, ModelType, AccessorType >::fireValue( const EventIdentifier& eventId )
{
  this->_owner->fireValuedSignal( eventId, ModelType( get() ) ) ;
}

//-----------------------------------------------------------------


#endif // defined OMK_ATTRIBUTE_INL

---