---

PsCalculus.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 developed 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 PsCalculusHEADER
#define PsCalculusHEADER


#include <Psn.h>
#include <PsObjectDescriptor.h>

class PsController ;
class PsName;
class PsInputNT;
class PsOutputNT;
class PsSimulatedObject ;
class PsEventListener ;
template <typename T> class PsNameToPointerMap;

class PsCalculus
{
public:

   PsCalculus (PsSimulatedObject &object) ;
   

   virtual ~PsCalculus () ;


   virtual void init () ;


   virtual void compute () ;


   virtual void finish () ;



   virtual void initUserInterface () ;


   virtual void runUserInterfaceDuringInit () ; 

   virtual void runUserInterface () ; 

   virtual void runUserInterfaceDuringSuspend () ;
   
   virtual void terminateUserInterface () ; 

//****************************************************
   

   virtual PsController & getController () const ; 
   

   virtual const PsDate & getSimulatedDate () const ;

   virtual PsSimulatedObject & getSimulatedObject () const ;

   /* get simulated object's name */
   virtual const PsName & getName () const ; 
   
   virtual const PsName & getClass () const ; 

   virtual const PsName & getProcess () const ; 

   virtual const PsFrequency & getFrequency () const ; 

   virtual float getPeriod () const ;


   virtual const PsConfigurationParameterDescriptor * getConfigurationParameters () const ;


   virtual const PsNameToPointerMap < PsInputNT > & getInputTable () const ; 
   
   
   virtual const PsNameToPointerMap < PsOutputNT > & getOutputTable () const ; 
   
   
   virtual const PsNameToPointerMap < PsOutputNT > & getControlParameterTable () const ; 
   

   virtual const list < PsEventListener * > & getEventListeners () const ;
   

   virtual PsInputNT * getPointerToInputNamed ( const PsName & inputName ) const;
   
   
   virtual PsOutputNT * getPointerToOutputNamed ( const PsName & outputName) const;
   
   
   virtual PsOutputNT * getPointerToControlParameterNamed ( const PsName & parameterName ) const ;

 
protected:

  PsSimulatedObject & _object;

private:

}; // PsCalculus

#endif

---