ColumnEnergyProbe.hpp

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

#ifndef COLUMNENERGYPROBE_HPP_
#define COLUMNENERGYPROBE_HPP_

#include "ColProbe.hpp"

namespace PV {

class BaseProbe;

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

   virtual ~ColumnEnergyProbe();

   int addTerm(BaseProbe *probe);

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

   virtual void calcValues(double timevalue) override;

  protected:
   ColumnEnergyProbe();

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

   virtual void outputHeader() override;

   virtual bool needRecalc(double timevalue) override;

   virtual double referenceUpdateTime() const override;

   virtual int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;
   virtual void ioParam_reductionInterval(enum ParamsIOFlag ioFlag);

   size_t numTerms;
   BaseProbe **terms;

  private:
   int initialize_base();

   int mSkipTimer        = 0;
   int mSkipInterval     = 0;
   double mLastTimeValue = -1;
}; // end class ColumnEnergyProbe

} // end namespace PV

#endif /* COLUMNENERGYPROBE_HPP_ */