AdaptiveTimeScaleProbe.hpp

/*
 * AdaptiveTimeScaleProbe.hpp
 *
 *  Created on: Aug 18, 2016
 *      Author: pschultz
 */

#ifndef ADAPTIVETIMESCALEPROBE_HPP_
#define ADAPTIVETIMESCALEPROBE_HPP_

#include "BaseProbe.hpp"
#include "ColProbe.hpp"
#include "components/AdaptiveTimeScaleController.hpp"
#include "layers/HyPerLayer.hpp"

namespace PV {

// AdaptiveTimeScaleProbe to be a subclass of ColProbe since it doesn't belong
// to a layer or connection, and the HyPerCol has to know of its existence to
// call various methods. It doesn't use any ColProbe-specific behavior other
// than ColProbe inserting the probe into the HyPerCol's list of ColProbes.
// Once the observer pattern is more fully implemented, it could probably
// derive straight from BaseProbe.
class AdaptiveTimeScaleProbe : public ColProbe {
  protected:
   virtual void ioParam_targetName(enum ParamsIOFlag ioFlag) override;

   virtual void ioParam_baseMax(enum ParamsIOFlag ioFlag);

   virtual void ioParam_baseMin(enum ParamsIOFlag ioFlag);

   virtual void ioParam_tauFactor(enum ParamsIOFlag ioFlag);

   virtual void ioParam_growthFactor(enum ParamsIOFlag ioFlag);

   // writeTimeScales was marked obsolete Jul 27, 2017.
   virtual void ioParam_writeTimeScales(enum ParamsIOFlag ioFlag);

   virtual void ioParam_writeTimeScaleFieldnames(enum ParamsIOFlag ioFlag);
  public:
   AdaptiveTimeScaleProbe(char const *name, HyPerCol *hc);
   virtual ~AdaptiveTimeScaleProbe();
   virtual Response::Status respond(std::shared_ptr<BaseMessage const> message) override;
   virtual Response::Status
   communicateInitInfo(std::shared_ptr<CommunicateInitInfoMessage const> message) override;
   virtual Response::Status allocateDataStructures() override;
   virtual Response::Status outputState(double timeValue) override;

  protected:
   AdaptiveTimeScaleProbe();
   int initialize(char const *name, HyPerCol *hc);
   int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;
   virtual Response::Status registerData(Checkpointer *checkpointer) override;
   Response::Status respondAdaptTimestep(std::shared_ptr<AdaptTimestepMessage const> message);
   bool needRecalc(double timeValue) override {
      return parent->simulationTime() > getLastUpdateTime();
   }
   double referenceUpdateTime() const override { return parent->simulationTime(); }
   virtual void calcValues(double timeValue) override;
   virtual bool needUpdate(double timeValue, double dt) override { return true; }
   virtual void allocateTimeScaleController();

  protected:
   double mBaseMax                = 1.0;
   double mBaseMin                = 1.0;
   double tauFactor               = 1.0;
   double mGrowthFactor           = 1.0;
   bool mWriteTimeScaleFieldnames = true;

   BaseProbe *mTargetProbe                                   = nullptr;
   AdaptiveTimeScaleController *mAdaptiveTimeScaleController = nullptr;
};

} /* namespace PV */

#endif /* ADAPTIVETIMESCALEPROBE_HPP_ */