---

modulator.h

/***************************************************************************
                          modulator.h  -  description
                             -------------------
    begin                : Mon Aug 11 2000
    copyright            : (C) 2000 by Michael Peeters
    email                : Michael.Peeters@vub.ac.be
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef MODULATOR_H
#define MODULATOR_H 

#include "numerictypes.h"
#include "numerictraits.h"
#include "vectorfunction.h"
#include "timeframe.h"
#include "parameter.h"
#include "cycler.h"
#include "ticktock.h"
#include <string>

namespace MODEL {

  class TimeFrame;
  
  class Modulator : public TickTock {
  public:
        template<integer dims, typename nelem, class NT  >
        Modulator(TimeFrame&
                          T,VectorFunction<dims,nelem,NT> & v, string param)
          : TickTock(T,T.get_dt()) // a modulator has the same resolution !
        {
          Parameter p=v.get_parameter(param);
          _p=&p;
        }

        virtual void tick() {(*_p)=modulate();}

        virtual number modulate(void)=0;
        
  private:
        number* _p;

  };

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

  class LinearMod : public Modulator{
  public:
        template<integer dims, typename nelem, class NT  >
        LinearMod( TimeFrame& T,
                           VectorFunction<dims,nelem,NT>& v, 
                           string param,
                           number start,number end, 
                           time from, time until ) : 
          Modulator(T,v,param), 
          st(start), 
          en(end), d(en-st), f (from), u(until/2.),du(u-f) {}

        virtual number modulate();
          
  private:
        number st;
        number en;
        number d;
        time f;
        time u;
        time du;
  };

  //--------------------------------------------------------------------------------
  class BlockMod : public Modulator{
  public:
        template<integer dims, typename nelem, class NT  >
        BlockMod( TimeFrame& T,
                           VectorFunction<dims,nelem,NT>& v, 
                           string param,
                           number low,number high, 
                           time period) : 
          Modulator(T,v,param), 
          l(low), h(high), p(period){}

        virtual number modulate(void);
          
  private:
        number l;
        number h;
        time p;
  };

  //-------------------------------------------------------------------------------
  class StepMod : public Modulator {
  public:
        template<integer dims, typename nelem, class NT  >
        StepMod( TimeFrame& T,
                         VectorFunction<dims,nelem,NT>& v, 
                         string param,
                         number start,number end, 
                         time at) 
          : Modulator(T,v,param), st(start), en(end), a (at) {}

        virtual number modulate();

  private:
        number st;
        number en;
        time a;
  };

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

  class TriangleFadeMod : public Modulator{
  public:
        template<integer dims, typename nelem, class NT  >
        TriangleFadeMod( TimeFrame& T,
                           VectorFunction<dims,nelem,NT>& v, 
                           string param,
                           number start,number end, 
                           time period, number deltapar, integer stay) : 
          Modulator(T,v,param), 
          st(start), 
          en(end), d(en-st), p(period), dp (deltapar), s(stay),cs(1) 
        { last_t=get_time(); in_t=0; }

        virtual number modulate();
          
  private:
        number st;
        number en;
        number d;
        time p ;
        number dp ;
        integer s;

        integer cs;
        time last_t;
        time in_t;
        
  };


} // end namespace
#endif

/*********************************************************************
$Id: modulator.h,v 1.1 2001/05/22 10:54:55 mpeeters Exp $
**********************************************************************

$Log: modulator.h,v $
Revision 1.1  2001/05/22 10:54:55  mpeeters
Moved sources and headers for libModel to model/ subdirectory, in an attempt to rationalize the source tree. This should make things "netter".

Revision 1.2  2000/09/15 10:26:31  mpeeters
Cleaned out header and added CVS tails to files, removed superfuous
@author comments, inserted dates

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

---

To get the sources or tarballs, please go to SourceForge or you can use the CVS repository.

More Info? Michael Peeters. Also, check our research website: www.alna.vub.ac.be

Last update: June 2002.

---

Looking for Open Source? Check out !