crate.h

#ifndef SCTAPI_CRATE
#define SCTAPI_CRATE

// Make sure all compilations have same SctApi structure!
#include "config.h"
#include "Sct/Addressing.h"

#include <boost/shared_ptr.hpp>

#include <vector>

//other fwddecs 
class MRSStream; // needed by Crate

namespace SctPixelRod {
  class RodOutList;
  class RodModule;
  class TimModule;
  class VmeInterface;
}

namespace SctConfiguration {
  class Configuration;
  class BOCChannelConfig;
  class BOCGlobalConfig;
}

#include "SctApiFwd.h"

namespace SctApi {
  class PrimListWrapper;

  class CrateException : public std::exception {
    std::string desc;
  public:
    CrateException(const std::string &str) throw() : desc(str) {}

    ~CrateException() throw() {}

    virtual const char* what () const throw() { return desc.c_str(); }
  };

class Crate {
  // Don't use copy constructor or assignment operator
  Crate(const Crate&);
  Crate &operator=(const Crate&);
  const Sct::UCID m_ucid;
 public:
  Crate(const Sct::UCID & ucid) : m_ucid(ucid) {};


  virtual ~Crate() {};
  const Sct::UCID & ucid() const {
    return m_ucid;
  };

  /************** Interaction with Configuration **************/


  virtual int initialiseCrate() = 0;


  virtual int initialiseTim() = 0;


  virtual int initialiseRod(unsigned int rod) = 0;


  virtual int initialiseBOC(unsigned int rod) = 0;


  virtual int configureBOC(unsigned int rod) = 0;

  /*************** Primlists *********************/


  virtual int sendPrimList(unsigned int rod, boost::shared_ptr<PrimListWrapper> prim) = 0;


  virtual int sendPrimListAll(boost::shared_ptr<PrimListWrapper> prim) = 0;


  virtual int awaitResponse(unsigned int rod, int timeout) = 0;


  virtual int awaitResponseAll(int timeout) = 0;


  virtual boost::shared_ptr<SctPixelRod::RodOutList> getResponse(unsigned int rod) = 0;

  virtual void setMrsStream(MRSStream *stream) = 0;

  /***************** Messages ******************/


  virtual bool getRodMessage(unsigned int rod, char *buffer, unsigned long &length) = 0;

  /************** Misc read/writes *****************/


  virtual int mdspBlockRead(unsigned int rod, long dspStart, unsigned long *buffer, unsigned long numWords) = 0;


  virtual int slvBlockRead(unsigned int rod, long dspStart, unsigned long *buffer, unsigned long numWords, long slaveNumber) = 0;


  virtual int slvBlockWrite(unsigned int rod, long dspStart, unsigned long* buffer, unsigned long numWords, long dspNumber) = 0;


  virtual int mdspBlockWrite(unsigned int rod, long dspStart, unsigned long *buffer, unsigned long numWords) = 0;


  virtual unsigned long readRodStatusReg(unsigned int rod, long regNumber) = 0;



  virtual unsigned long readRodCommandReg(unsigned int rod, long regNumber) = 0;


  virtual unsigned long dspSingleRead(unsigned int rod, const unsigned long dspAddr, long dspNumber) = 0;


  virtual int dspSingleWrite(unsigned int rod, unsigned long dspAddr, unsigned long buffer, long dspNumber) = 0;

  virtual std::string status() = 0;


  virtual std::list<unsigned> getListOfRods() const = 0;


  enum PLControl {
    C_PL_STOP,
    C_PL_PAUSE,
    C_PL_RESUME,
    C_PL_CANCEL };

  virtual void primListControl(unsigned int rod, PLControl function) = 0;

  virtual void printBOCSetup(unsigned int rod) = 0;

  virtual std::vector<SctConfiguration::BOCChannelConfig> currentBOCSetup(unsigned int rod) = 0;

  virtual void printBOCRegisters(unsigned int rod) = 0;

  virtual SctConfiguration::BOCGlobalConfig currentBOCRegisters(unsigned int rod) = 0;

  virtual void saveBOCSetup(unsigned int rod, BankType bank) = 0;
  virtual void saveBOCRegisters(unsigned int rod, BankType bank) = 0;

  virtual void restoreBOCSetup(unsigned int rod, BankType bank) = 0;
  virtual void restoreBOCRegisters(unsigned int rod, BankType bank) = 0;

  virtual bool checkBOCLasersOn(unsigned int rod) = 0;

  virtual void enterBOCClockBy2Mode(unsigned int rod) = 0;

  virtual void leaveBOCClockBy2Mode(unsigned int rod) = 0;

  virtual std::vector<double> getBOCMonitorArray(unsigned int rod) = 0;

  virtual void modifyTIMParam(unsigned int type, unsigned int val) = 0;


  virtual void modifyBOCParam(unsigned int type, unsigned int val, bool raw) = 0;


  virtual void modifyBOCParam(unsigned int rod, unsigned int channel, unsigned int type, unsigned int val, bool raw) = 0;

  virtual void lasersOff() = 0;

  /* ******************* TIM Functions ***************************/


  virtual void timSetFrequency(double trigFreq, double rstFreq) = 0;

  virtual double timGetTriggerFrequency() = 0;

  virtual double timGetResetFrequency() = 0;

  virtual void freeTriggers() = 0;

  virtual void stopTriggers() = 0;

  virtual void timLoadSequence(const std::vector<unsigned>& seq) = 0;
  virtual unsigned long timRunSequence(long unsigned ntrigs, int random, bool external) = 0;
  
  virtual void timL1A() = 0;

  virtual void timCalL1A(int delay) = 0;

  virtual void timECR() = 0;

  virtual void timBCR() = 0;

  virtual void timFER() = 0;

  virtual unsigned long sendTimBurst(unsigned long count, int random, bool external) = 0;

  virtual void timVerbose() = 0;

  virtual void timRegLoad(int reg, UINT16 val) = 0;

  virtual UINT16 timRegRead(int reg) = 0;

  virtual bool slavePresent(int rod, int index) const = 0;

  virtual void slaveStarted(int rod, int slave) = 0;

  virtual bool RODPresent(int rod) const = 0;

  virtual long getRodSlot(int rod) const = 0;

  virtual int getRodRevision(int rod) const = 0;

  virtual void stopPolling() = 0;

  virtual void resumePolling() = 0;
  
  // get the RodModule object for a particular rod
  SctPixelRod::RodModule *getRod(unsigned int rod) const;
};

}  // End of namespace SctApi
#endif

---