HyPerDelivery.hpp

/*
 * HyPerDelivery.hpp
 *
 *  Created on: Aug 24, 2017
 *      Author: Pete Schultz
 */

#ifndef HYPERDELIVERY_HPP_
#define HYPERDELIVERY_HPP_

#include "BaseDelivery.hpp"
#include "components/ArborList.hpp"
#include "components/WeightsPair.hpp"

namespace PV {

class HyPerDelivery : public BaseDelivery {
  protected:
   virtual void ioParam_convertRateToSpikeCount(enum ParamsIOFlag ioFlag); // End of list of HyPerDeliveryFacade parameters.

  public:
   enum AccumulateType { UNDEFINED, CONVOLVE, STOCHASTIC };

   HyPerDelivery(char const *name, HyPerCol *hc);

   virtual ~HyPerDelivery();

   void setConnectionData(ConnectionData *connectionData);

   virtual void deliver() override = 0;

   virtual bool isAllInputReady() override;

  protected:
   HyPerDelivery();

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

   virtual void setObjectType() override;

   virtual int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;

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

   virtual Response::Status allocateDataStructures() override;

   double convertToRateDeltaTimeFactor(double timeConstantTau) const;

   // Data members
  protected:
   AccumulateType mAccumulateType      = CONVOLVE;
   bool mUpdateGSynFromPostPerspective = false;
   bool mConvertRateToSpikeCount       = false;

   float mDeltaTimeFactor    = 1.0f;
   WeightsPair *mWeightsPair = nullptr;
   ArborList *mArborList     = nullptr;

}; // end class HyPerDelivery

} // end namespace PV

#endif // HYPERDELIVERY_HPP_