HyPerDeliveryFacade.hpp

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

#ifndef HYPERDELIVERYFACADE_HPP_
#define HYPERDELIVERYFACADE_HPP_

#include "delivery/BaseDelivery.hpp"
#include "delivery/HyPerDelivery.hpp"

namespace PV {

class HyPerDeliveryFacade : public BaseDelivery {
  protected:
   virtual void ioParam_accumulateType(enum ParamsIOFlag ioFlag);

   virtual void ioParam_updateGSynFromPostPerspective(enum ParamsIOFlag ioFlag); // End of list of HyPerDeliveryFacade parameters.

  public:
   HyPerDeliveryFacade(char const *name, HyPerCol *hc);

   virtual ~HyPerDeliveryFacade();

   virtual void deliver() override;

   virtual void deliverUnitInput(float *recvBuffer) override;

   virtual bool isAllInputReady() override;

   HyPerDelivery::AccumulateType getAccumulateType() const { return mAccumulateType; }

   bool getUpdateGSynFromPostPerspective() const { return mUpdateGSynFromPostPerspective; }

   bool getConvertRateToSpikeCount() const { return mConvertRateToSpikeCount; }

  protected:
   HyPerDeliveryFacade();

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

   virtual void setObjectType() override;

   virtual int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;

   void createDeliveryIntern();

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

#ifdef PV_USE_CUDA
   virtual Response::Status
   setCudaDevice(std::shared_ptr<SetCudaDeviceMessage const> message) override;
#endif // PV_USE_CUDA

   virtual Response::Status allocateDataStructures() override;

   // Data members
  protected:
   HyPerDelivery::AccumulateType mAccumulateType = HyPerDelivery::CONVOLVE;

   char *mAccumulateTypeString         = nullptr;
   bool mUpdateGSynFromPostPerspective = false;

   // Whether to check if pre-layer is spiking and, if it is not,
   // scale activity by dt to convert it to a spike count
   bool mConvertRateToSpikeCount = false;

   HyPerDelivery *mDeliveryIntern = nullptr;
}; // end class HyPerDeliveryFacade

} // end namespace PV

#endif // HYPERDELIVERYFACADE_HPP_