OMKGenericControlParameter.h

Go to the documentation of this file.

/*
 * This file is part of openMask © 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 Université de Rennes 1 
 * for the software may use this file in accordance with that specific license 
 *
 */
#ifndef GenericControlParameterHEADER
#define GenericControlParameterHEADER

#include "OMKKernelAttribute.h"

namespace OMK
{
  template< typename T > class ChangedControlParameterEventListener ;

template< typename T, class AncestorClass >
class GenericControlParameter : virtual public KernelAttribute, 
                                public AncestorClass, 
                                public ControlParameter< T >
{
 public:
  using ControlParameter< T >::getAssociatedEventId ;
  

public:

   GenericControlParameter( const Name & attributeName, 
                            SimulatedObject & owner,
                            const int historyLength,
                            OMK::Type::PolatorNT * polator ) ;
   
   virtual ~GenericControlParameter() ;
   
   virtual const T & get( int & distanceToExactValue,
                          const int precisionLevel,
                          const Date & deltaT,
                          T & calculatedResult ) const ;


   virtual const T & get() const;
   
   virtual const T & getLastExactValue() const;


   virtual const Date & getDateOfLastExactValue() const;


   virtual void set( const T & val ) ;

   virtual void extract( std::istream & = std::cin ) ;
   
   virtual void unpack( IncomingSynchronisationMessage & ) ;
   
   virtual void pack( OutgoingSynchronisationMessage & ) const ;

   virtual void insertInStream( std::ostream & = std::cout ) const;

  virtual void printDebuggingInformation( std::ostream & err ) const ;


   virtual bool connect( const Name & objectName, const Name & inputName ) ;


   virtual bool connect( SimulatedObject & object, const Name & inputName ) ;


   virtual bool connect( SimulatedObject * pointerToObject, const Name & inputName ) ;

protected:
   virtual void realSet(  const T & val ) ;
   
   ChangedControlParameterEventListener<T> * _associatedEventListener ;
 } ; // ControlParameter

} // namespace OMK


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


#include "OMKChangedControlParameterEventListener.h"
#include "OMKCurrentActiveObject.h"

namespace OMK
{

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

template< typename T, class AncestorClass >
inline GenericControlParameter< T, AncestorClass >::GenericControlParameter(
  const Name & controlParameterName,
  SimulatedObject & owner,
  const int historyLength,
  OMK::Type::PolatorNT * polator )
  :  KernelAttribute( owner, controlParameterName ),
     AncestorClass( controlParameterName,
                    owner,
                    historyLength,
                    polator ),
     ControlParameter< T >( owner, 
                            controlParameterName,
                            ( "ChangedControlParameter::" +
                              controlParameterName.getString() ) )
{
  _associatedEventListener =
    new ChangedControlParameterEventListener< T >( owner, *this ) ;
}

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

template< typename T, class AncestorClass >
inline GenericControlParameter< T, AncestorClass >::~GenericControlParameter()
{
  delete _associatedEventListener ;
}

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

template< typename T, class AncestorClass >
inline void GenericControlParameter< T, AncestorClass >::set( const T & val )
{
   SimulatedObject * caller = CurrentActiveObject::getCurrentActiveObject() ;
   if( caller != 0 && caller != &_owner )
   {
     caller->sendValuedEvent( _owner, getAssociatedEventId(), val ) ;
   }
   else
   {
     /* Probably in initialisation phase : suppose the owner is calling set
      * with the initial value.
      * WARNING: this is a security hole because the currentActiveObject can
      * easily be changed.
      */
     realSet( val ) ;
   }
}

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

template< typename T, class AncestorClass >
inline void GenericControlParameter< T, AncestorClass >::realSet(
  const T & val )
{
  if( _owner.getObjectHandle() != 0 )
  {//during initialisation phase, objectHandle of the owner can be null
    _owner.getObjectHandle()->notifyChangeInControlParameter( this ) ;
  }
  AncestorClass::set( val ) ;
}

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

template< typename T, class AncestorClass >
inline void GenericControlParameter< T, AncestorClass >::insertInStream(
  std::ostream & out ) const
{
  /* Thread safety assessement : as thread safe as localInsert
   */
  AncestorClass::insertInStream( out ) ; 
}

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

template< typename T, class AncestorClass >
inline void GenericControlParameter< T, AncestorClass >::extract(
  std::istream & in )
{
  /* Thread safety assessement : as thread safe as localInsert
   */
  AncestorClass::extract( in ) ;
}

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

template< typename T, class AncestorClass >
inline void GenericControlParameter< T, AncestorClass >::pack(
  OutgoingSynchronisationMessage & out ) const
{
  /* Thread safety assessement : as thread safe as localInsert
   */
  AncestorClass::pack( out ) ;
}

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

template< typename T, class AncestorClass >
inline void GenericControlParameter< T, AncestorClass >::unpack(
  IncomingSynchronisationMessage & in )
{
  /* Thread safety assessement : as thread safe as localInsert
   */
  AncestorClass::unpack( in ) ;
}

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

template< typename T, class AncestorClass >
inline void GenericControlParameter< T, AncestorClass >::printDebuggingInformation(
  std::ostream & err ) const
{
  AncestorClass::printDebuggingInformation( err ) ;
  err << " Output is a control parameter " << std::endl ;
}

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

template< typename T, class AncestorClass >
const T & GenericControlParameter< T, AncestorClass >::get(
  int & distanceToExactValue,
  const int precisionLevel,
  const Date & deltaT,
  T & calculatedResult ) const
{
  return AncestorClass::get( distanceToExactValue, precisionLevel, deltaT,
                             calculatedResult ) ;
}

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

template< typename T, class AncestorClass >
inline const T & GenericControlParameter< T, AncestorClass >::get() const
{
  return AncestorClass::getLastExactValue() ;
}

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

template< typename T, class AncestorClass >
inline const Date & GenericControlParameter< T, AncestorClass >::getDateOfLastExactValue() const
{
  return AncestorClass::getDateOfLastExactValue() ;
}

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

template< typename T, class AncestorClass >
inline const T & GenericControlParameter< T, AncestorClass >::getLastExactValue() const 
{
  return AncestorClass::getLastExactValue() ;
}

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

template< typename T, class AncestorClass >
bool GenericControlParameter< T, AncestorClass >::connect(
  const Name & objectName, const Name & inputName )
{
  return AncestorClass::connect( objectName, inputName ) ;
}

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

template< typename T, class AncestorClass >
bool GenericControlParameter< T, AncestorClass >::connect(
  SimulatedObject & object, const Name & inputName )
{
  return AncestorClass::connect( object, inputName ) ;
}

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

template< typename T, class AncestorClass >
bool GenericControlParameter< T, AncestorClass >::connect(
  SimulatedObject * pointerToObject, const Name & inputName )
{
  return AncestorClass::connect( pointerToObject, inputName ) ;
}

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

} // namespace OMK

#endif

---