---

PsGenericControlParameter.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 PsGenericControlParameterHEADER
#define PsGenericControlParameterHEADER

#include "PsAttribute.h"

template <typename Type> class PsChangedControlParameterEventListener ;

template <typename Type, class AncestorClass>
class PsGenericControlParameter : virtual public PsAttribute, 
                                  public AncestorClass, 
                                  public PsControlParameter<Type>
{
public:

   PsGenericControlParameter (const PsName & attributeName, 
                              PsSimulatedObject & owner,
                              const int historyLength,
                              PsPolatorNT * polator) ;
   
   virtual ~PsGenericControlParameter (void) ;
   
   virtual const Type & get (int & distanceToExactValue,
                             const int precisionLevel,
                             const PsDate & deltaT,
                             Type & calculatedResult ) const ;


   virtual const Type & get (void) const;
   
   virtual const Type & getLastExactValue (void) const;


   virtual const PsDate & getDateOfLastExactValue (void) const;


   virtual void set (const Type & val) ; 

   virtual void extract (istream & = cin);
   
   virtual void unpack (PsIncomingSynchronisationMessage &) ;
   
   virtual void pack (PsOutgoingSynchronisationMessage &) const ;

   virtual void insertInStream (ostream & = cout) const;

  virtual void printDebuggingInformation(ostream & err) const ;


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


   virtual bool connect (PsSimulatedObject & object, const PsName & inputName ) ;


   virtual bool connect (PsSimulatedObject * pointerToObject, const PsName & inputName ) ;

protected:
   virtual void realSet ( const Type & val ) ;
   
   PsChangedControlParameterEventListener<Type> * _associatedEventListener ;
 } ; // PsControlParameter



#include "PsChangedControlParameterEventListener.h"
#include "PsnCurrentActiveObject.h"
template <typename Type, class AncestorClass>
inline PsGenericControlParameter<Type,AncestorClass>::PsGenericControlParameter(const PsName & controlParameterName,
                                                                  PsSimulatedObject & owner,
                                                                  const int historyLength,
                                                                  PsPolatorNT * polator) : 
   PsAttribute (owner, controlParameterName),  
   AncestorClass (controlParameterName,
                  owner,
                  historyLength,
                  polator),
   PsControlParameter<Type> (owner, 
                             controlParameterName,
                             PsString("ChangedControlParameter::")+controlParameterName.getCString() )
{
   _associatedEventListener = new PsChangedControlParameterEventListener<Type>(owner, *this ) ;
   owner.addEventListener( *_associatedEventListener ) ;
}

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

template <typename Type, class AncestorClass>
inline PsGenericControlParameter<Type,AncestorClass>::~PsGenericControlParameter (void)
{
   delete _associatedEventListener ;
}



template <typename Type, class AncestorClass>
inline void PsGenericControlParameter<Type,AncestorClass>::set (const Type & val)
{
   PsSimulatedObject * caller = PsnCurrentActiveObject::getCurrentActiveObject() ;
   if ( (caller != NULL) &&
        (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 Type, class AncestorClass>
inline void PsGenericControlParameter<Type,AncestorClass>::realSet (const Type & val)
{
   if ( _owner.getObjectHandle() != NULL )
      {//during initialisation phase, objectHandle of the owner can be null
         _owner.getObjectHandle()->notifyChangeInControlParameter (this) ;
      }
   AncestorClass::set(val) ;
} 



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

template <typename Type, class AncestorClass>
inline void PsGenericControlParameter<Type,AncestorClass>::extract (istream & in) 
{
   /*thread safety assessement :
     As thread safe as localInsert 
   */
   AncestorClass::extract ( in ) ; 
}


template <typename Type, class AncestorClass>
inline void PsGenericControlParameter<Type,AncestorClass>::pack (PsOutgoingSynchronisationMessage & out) const
{
   /*thread safety assessement :
     As thread safe as localInsert 
   */
   AncestorClass::pack ( out ) ; 
}

template <typename Type, class AncestorClass>
inline void PsGenericControlParameter<Type,AncestorClass>::unpack (PsIncomingSynchronisationMessage & in) 
{
   /*thread safety assessement :
     As thread safe as localInsert 
   */
   AncestorClass::unpack ( in ) ; 
}


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

template <typename Type, class AncestorClass>
const Type & PsGenericControlParameter<Type,AncestorClass>::get (int & distanceToExactValue,
                                                                 const int precisionLevel,
                                                                 const PsDate & deltaT,
                                                                 Type & calculatedResult ) const 
{
   return AncestorClass::get(distanceToExactValue,precisionLevel,deltaT,calculatedResult );
}

template <typename Type, class AncestorClass>
inline const Type & PsGenericControlParameter<Type,AncestorClass>::get (void) const 
{
  return AncestorClass::getLastExactValue ( ) ;
}


template <typename Type, class AncestorClass>
inline const PsDate & PsGenericControlParameter<Type,AncestorClass>::getDateOfLastExactValue (void) const 
{
  return AncestorClass::getDateOfLastExactValue ( ) ;
}

template <typename Type, class AncestorClass>
inline const Type & PsGenericControlParameter<Type,AncestorClass>::getLastExactValue (void) const 
{
  return AncestorClass::getLastExactValue ( ) ;
}

template <typename Type, class AncestorClass>
bool PsGenericControlParameter<Type,AncestorClass>::connect (const PsName & objectName, const PsName & inputName ) 
{
   return AncestorClass::connect (objectName, inputName) ;
}


template <typename Type, class AncestorClass>
bool PsGenericControlParameter<Type,AncestorClass>::connect (PsSimulatedObject & object, const PsName & inputName ) 
{
   return AncestorClass::connect (object, inputName) ;
}


template <typename Type, class AncestorClass>
bool PsGenericControlParameter<Type,AncestorClass>::connect (PsSimulatedObject * pointerToObject, const PsName & inputName )
{
   return AncestorClass::connect (pointerToObject, inputName) ;
}

#endif

---