AbstractNormProbe.hpp

/*
 * AbstractNormProbe.hpp
 *
 *  Created on: Aug 11, 2015
 *      Author: pschultz
 */

#ifndef ABSTRACTNORMPROBE_HPP_
#define ABSTRACTNORMPROBE_HPP_

#include "LayerProbe.hpp"

namespace PV {

class AbstractNormProbe : public LayerProbe {
  public:
   AbstractNormProbe(const char *name, HyPerCol *hc);
   virtual ~AbstractNormProbe();

   HyPerLayer *getMaskLayer() { return maskLayer; }

   char const *getMaskLayerName() { return maskLayerName; }

  protected:
   AbstractNormProbe();
   int initialize(const char *name, HyPerCol *hc);

   virtual int setNormDescription();

   int setNormDescriptionToString(char const *s);

   virtual int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;

   virtual void ioParam_maskLayerName(enum ParamsIOFlag ioFlag);
   virtual void calcValues(double timeValue) override;

   virtual double getValueInternal(double timevalue, int index) = 0;

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

   bool maskHasSingleFeature() { return singleFeatureMask; }

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

   char const *getNormDescription() { return normDescription; }

  private:
   int initialize_base();

  private:
   char *normDescription;
   char *maskLayerName;
   HyPerLayer *maskLayer;
   bool singleFeatureMask;

   double timeLastComputed; // the value of the input argument timevalue for the
   // most recent
   // getValues() call.  Calls to getValue() do not set or refer to this
   // time.

}; // end class AbstractNormProbe

} // end namespace PV

#endif /* ABSTRACTNORMPROBE_HPP_ */