QuotientColProbe.hpp

/*
 * QuotientColProbe.hpp
 *
 *  Created on: Aug 12, 2015
 *      Author: pschultz
 */

#ifndef QUOTIENTCOLPROBE_HPP_
#define QUOTIENTCOLPROBE_HPP_

#include "ColProbe.hpp"

namespace PV {

class BaseProbe;

class QuotientColProbe : public ColProbe {
  public:
   QuotientColProbe(const char *probename, HyPerCol *hc);

   virtual ~QuotientColProbe();

   virtual int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;

   virtual void ioParam_valueDescription(enum ParamsIOFlag ioFlag);

   virtual void ioParam_numerator(enum ParamsIOFlag ioFlag);

   virtual void ioParam_denominator(enum ParamsIOFlag ioFlag);
 /* end of io functions for QuotientColProbe parameters */

   virtual Response::Status
   communicateInitInfo(std::shared_ptr<CommunicateInitInfoMessage const> message) override;

   virtual Response::Status outputState(double timevalue) override;

  protected:
   QuotientColProbe();

   int initializeQuotientColProbe(const char *probename, HyPerCol *hc);

   virtual bool needRecalc(double timevalue) override { return true; }

   virtual double referenceUpdateTime() const override;

   virtual void calcValues(double timeValue) override;

   virtual void outputHeader() override;

  private:
   int initialize_base();

   // Member variables
  protected:
   char *valueDescription; // A string description of the quantity calculated by
   // the probe, used by
   // outputHeader
   char *numerator; // The name of the probe that supplies the numerator
   char *denominator; // The name of the probe that supplies the denominator
   BaseProbe *numerProbe; // A pointer to the probe that supplies the numerator.
   BaseProbe *denomProbe; // A pointer to the probe that supplies the denominator.

}; // end class QuotientColProbe

} // end namespace PV

#endif /* QUOTIENTCOLPROBE_HPP_ */