---

configuration.h

Go to the documentation of this file.

#ifndef SCTAPI_CONFIGURATION
#define SCTAPI_CONFIGURATION

#include <list>
#include <string>
#include <stdexcept>

// For ABCDModule
#include <CommonWithDsp/sctStructure.h>

/*  struct xmlDoc; */
/*  struct xmlXPathContext; */

/*  typedef struct xmlDoc *xmlDocPtr; */
/*  typedef struct xmlXPathContext *xmlXPathContextPtr; */

namespace SctConfiguration {

struct SlaveConfig {
  std::string emifFile;
  std::string ipramFile;
  std::string idramFile;
  std::string extFile;
};

struct RodConfig {
/*   
/*   bool bocPresent; */
  unsigned long baseAddress;
  unsigned long mapSize;
  unsigned long resetLevel;
  long numSlaves;
  SlaveConfig slaves[4];
};

struct TimConfig {
  unsigned long baseAddress;
  unsigned long mapSize;
};

struct BOCChannelConfig {
  int current;
  int delay;
  int markSpace;
  int threshold0;
  int delay0;
  int threshold1;
  int delay1;

  int txFibre;
  int rxFibre0;
  int rxFibre1;
};

struct BOCGlobalConfig {
  int validMask;

  int clockControl;
  int rxDataMode;
  int rxDacClear;
  int txDacClear;
  int vernierFinePhase;
  int vernierClockPhase0;
  int vernierClockPhase1;
  int bpmClockPhase;
  int bregClockPhase;
};

enum MURType {BARREL, ENDCAP, UNMAPPED, UNKNOWN};

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

  ~ConfigurationException() throw() {}

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

class Configuration {
public:
  virtual ~Configuration() {};

  /************* Get physical configuration ****************/

  virtual std::list<unsigned int> listPartitions() = 0;

  virtual std::list<unsigned int> listCratesInPartition(unsigned int partition) = 0;

  virtual bool isDummyCrate(unsigned int partition, unsigned int crate) = 0;

  virtual std::list<unsigned int> listRodsInCrate(unsigned int partition, unsigned int crate) = 0;

  virtual std::list<unsigned int> listMURSInRod(unsigned int partition, unsigned int crate, unsigned int rod) = 0;

  virtual std::list<std::string> listModulesInMUR(unsigned int partition, unsigned int MUR) = 0;

  virtual std::list<std::string> listRModulesInMUR(unsigned int partition, unsigned int MUR) = 0;

  virtual std::list<std::string> listAllModules() = 0;

  virtual std::list<std::string> listUnusedModules() = 0;

  /************** Get configurations *****************/

  virtual ABCDModule getModuleConfig(const std::string module) = 0;

  virtual RodConfig getRodConfig(unsigned int partition, unsigned int crate, unsigned int rod) = 0;

  virtual BOCChannelConfig getBOCConfig(unsigned int partition, unsigned int crate, unsigned int rod, 
                                        unsigned int channel) = 0;

  virtual BOCGlobalConfig getBOCGlobalConfig(unsigned int partition, unsigned int crate, unsigned int rod) = 0;

  virtual char *getFibreMappings(unsigned int partition, unsigned int crate, unsigned int rod) = 0;

  virtual TimConfig getTimConfig(unsigned int partition, unsigned int crate) = 0;

  virtual void setFibreMapping(unsigned int partition, unsigned int crate, unsigned int rod, 
                               unsigned int channel, unsigned int tx, unsigned int rx0, unsigned int rx1) = 0;

  virtual void printModuleConfig(const ABCDModule &conf) = 0;

  virtual MURType getMURType(unsigned int MUR) = 0;

  /************** Change indexing schemes ****************/

  virtual void translateToROD(unsigned int MUR, unsigned int module,
                              unsigned int &partition, unsigned int &crate, 
                              unsigned int &rod, unsigned int &channel) = 0;
 
  virtual void translateToRROD(unsigned int MUR, unsigned int module,
                               unsigned int &partition, unsigned int &crate, 
                               unsigned int &rod, unsigned int &channel) = 0;
 
  virtual void translateToSN(unsigned int MUR, unsigned int module,
                             std::string &sn) = 0;

  virtual void translateToBarrel(unsigned int MUR, unsigned int module,
                                 unsigned int &barrel, unsigned int &row, int &number) = 0;

  virtual void translateToEndcap(unsigned int MUR, unsigned int module,
                                 unsigned int &disk, unsigned int &ring, unsigned int &number) = 0;

  virtual void translateToPowerSupply(unsigned int MUR, unsigned int module,
                                      unsigned int &partition, 
                                      unsigned int &crate, unsigned int &channel) = 0;

  virtual void translateFromROD(unsigned int partition, unsigned int crate, 
                                unsigned int rod, unsigned int channel,
                                unsigned int &MUR, unsigned int &module) = 0;

  virtual void translateFromRROD(unsigned int partition, unsigned int crate,
                                 unsigned int rod, unsigned int channel,
                                 unsigned int &MUR, unsigned int &module) = 0;

  virtual void translateFromSN(const std::string sn,
                               unsigned int &MUR, unsigned int &module) = 0;

  virtual void translateFromBarrel(unsigned int barrel, unsigned int row, int number,
                                   unsigned int &MUR, unsigned int &module) = 0;

  virtual void translateFromEndcap(unsigned int disk, unsigned int ring, unsigned int number,
                                   unsigned int &MUR, unsigned int &module) = 0;

  virtual void translateFromPowerSupply(unsigned int partition, 
                                        unsigned int crate, unsigned int channel, 
                                        unsigned int &MUR, unsigned int &module) = 0;


  /************** Change configuration ******************/

  virtual void configureModuleFromStructure(const std::string module, const ABCDModule conf) = 0;

  virtual void configureModuleFromFile(const std::string filename) = 0;

  virtual void configureROD(unsigned int partition, unsigned int crate, unsigned int rod, RodConfig conf) = 0;

  virtual void configureTIM(unsigned int partition, unsigned int crate, TimConfig conf) = 0;

  virtual void configureBOC(unsigned int partition, unsigned int crate, unsigned int rod, const BOCGlobalConfig &conf) = 0;

  virtual void clearAll() = 0;

  virtual void namePartition(int partition, const std::string name) = 0;

/*virtual    void setBOCConfig(int partition, int crate, int rod, int channel, const BOCChannelConfig &conf) = 0; */
  
  virtual void configureBOCChannel(int MUR, int position, const BOCChannelConfig &conf) = 0;

  virtual void mapModuleMUR(int MUR, int order, int RMUR, int rorder, std::string number) = 0;

  virtual void mapRODMUR(int partition, int crate, int rod, int order, int number) = 0;

  virtual void mapBarrelMUR(int MUR, int barrel, int row, int position) = 0;

  virtual void swapMURNames(int MUR1, int MUR2) = 0;

/* #warning "Need to think more about endcap mappings" */

  virtual void mapEndcapMUR(int MUR, int disk, int quadrant, int position) = 0;

  virtual void mapPowerChannel(int MUR, int number, unsigned int partition, unsigned int crate, unsigned int channel) = 0;

  virtual void modifyPowerParam(int MUR, int number, std::string name, float value) = 0;

  virtual void modifyDefaultPowerParam(std::string name, float value) = 0;

  virtual float getPowerParam(int MUR, int number, std::string name) = 0;

  virtual void loadConfiguration(const std::string &filename) = 0;

  /************** Save configuration *********************/

  virtual void saveConfiguration(const std::string filename = "") = 0;

  virtual void saveModuleConfiguration(const std::string modsn, const std::string filename) = 0;

  virtual std::string getModuleConfigurationString(const std::string modsn, const ABCDModule config) = 0;

  virtual void writePowerSupplyConfiguration(std::string filename) = 0;
 protected:
/*   virtual void createPartition(int partition) = 0; */

/*   virtual void createCrate(int partition, int crate) = 0; */

/*   virtual void createROD(int partition, int crate, int rod) = 0; */

/*   virtual void createMUR(int partition, int crate, int rod, int order, int number) = 0; */

/*virtual    void createModule(int MUR, int order, int RMUR, int rorder, string number, const ABCDModule &mConf) = 0; */

/*   virtual void createBOCConfig(int MUR, int order, const BOCChannelConfig &bConf) = 0; */

};

}

#endif

---