BaseConnectionProbe.hpp

/*
 * BaseConnectionProbe.hpp
 *
 *  Created on: Oct 20, 2011
 *      Author: pschultz
 */

#ifndef BASECONNECTIONPROBE_HPP_
#define BASECONNECTIONPROBE_HPP_

#include "../connections/BaseConnection.hpp"

enum PatchIDMethod { INDEX_METHOD, COORDINATE_METHOD };

namespace PV {

class BaseConnectionProbe : public BaseProbe {

   // Methods
  public:
   BaseConnectionProbe(const char *name, HyPerCol *hc);
   virtual ~BaseConnectionProbe();

   virtual Response::Status respond(std::shared_ptr<BaseMessage const> message) override;

   BaseConnection *getTargetConn() { return mTargetConn; }

  protected:
   BaseConnectionProbe(); // Default constructor, can only be called by derived
   // classes
   int initialize(const char *name, HyPerCol *hc);
   virtual void ioParam_targetName(enum ParamsIOFlag ioFlag) override;

   Response::Status respondConnectionProbeWriteParams(
         std::shared_ptr<ConnectionProbeWriteParamsMessage const> message);

   Response::Status respondConnectionOutput(std::shared_ptr<ConnectionOutputMessage const> message);

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

   virtual Response::Status registerData(Checkpointer *checkpointer) override;

   virtual void initOutputStreams(const char *filename, Checkpointer *checkpointer) override;

   // Member Variables
  protected:
   BaseConnection *mTargetConn = nullptr; // The connection being probed.
   Timer *mIOTimer             = nullptr;
};

} // end of namespace PV block

#endif /* BASECONNECTIONPROBE_HPP_ */