BaseDelivery.hpp

/*
 * BaseDelivery.hpp
 *
 *  Created on: Nov 17, 2017
 *      Author: Pete Schultz
 */

#ifndef BASEDELIVERY_HPP_
#define BASEDELIVERY_HPP_

#include "columns/BaseObject.hpp"
#include "components/ConnectionData.hpp"
#include "layers/HyPerLayer.hpp"

namespace PV {

class BaseDelivery : public BaseObject {
  protected:
   virtual void ioParam_channelCode(enum ParamsIOFlag ioFlag);

   virtual void ioParam_receiveGpu(enum ParamsIOFlag ioFlag); // end of BaseDelivery parameters

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

   virtual ~BaseDelivery() {}

   virtual void deliver() {}

   virtual void deliverUnitInput(float *recvBuffer) {}

   virtual bool isAllInputReady() { return true; }

   ChannelType getChannelCode() const { return mChannelCode; }
   bool getReceiveGpu() const { return mReceiveGpu; }
   HyPerLayer *getPreLayer() const { return mPreLayer; }
   HyPerLayer *getPostLayer() const { return mPostLayer; }

  protected:
   BaseDelivery() {}

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

   virtual void setObjectType() override;

   int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;

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

  protected:
   ChannelType mChannelCode = CHANNEL_EXC;
   bool mReceiveGpu         = false;

   ConnectionData *mConnectionData = nullptr;
   HyPerLayer *mPreLayer           = nullptr;
   HyPerLayer *mPostLayer          = nullptr;
   // Rather than the layers, should we store the buffers and the PVLayerLoc data?
};

} // namespace PV

#endif // BASEDELIVERY_HPP_