ArborList.hpp

/*
 * ArborList.hpp
 *
 *  Created on: Jan 5, 2018
 *      Author: pschultz
 */

#ifndef ARBORLIST_HPP_
#define ARBORLIST_HPP_

#include "columns/BaseObject.hpp"

namespace PV {

class ArborList : public BaseObject {
  protected:
   virtual void ioParam_numAxonalArbors(enum ParamsIOFlag ioFlag);

   virtual void ioParam_delay(enum ParamsIOFlag ioFlag);
 // end of ArborList parameters

  public:
   ArborList(char const *name, HyPerCol *hc);
   virtual ~ArborList();

   virtual void setObjectType() override;

   int getNumAxonalArbors() const { return mNumAxonalArbors; }

   int getDelay(int arbor) const { return mDelay[arbor]; }

  protected:
   ArborList();

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

   virtual int ioParamsFillGroup(enum ParamsIOFlag ioFlag) override;

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

   void initializeDelays();

   void setDelay(int arborId, double delay);

   int maxDelaySteps();

  protected:
   int mNumAxonalArbors = 1;
   std::vector<int> mDelay; // The delays expressed in # of timesteps (delays ~= fDelayArray / t)
   double *mDelaysParams = nullptr; // The raw delays in params, in the same units that dt is in.
   int mNumDelays        = 0; // The size of the mDelayParams array

}; // class ArborList

} // namespace PV

#endif // ARBORLIST_HPP_