evr.h

Go to the documentation of this file.

/*************************************************************************\
* Copyright (c) 2010 Brookhaven Science Associates, as Operator of
*     Brookhaven National Laboratory.
* Copyright (c) 2015 Paul Scherrer Institute (PSI), Villigen, Switzerland
* mrfioc2 is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
\*************************************************************************/
/*
 * Author: Michael Davidsaver <mdavidsaver@gmail.com>
 */

#ifndef EVR_HPP_INC
#define EVR_HPP_INC

#include <epicsTypes.h>
#include <epicsTime.h>
#include <callback.h>
#include <dbScan.h>

#include "evr/output.h"
#include "mrf/object.h"

#include "configurationInfo.h"

class Pulser;
class PreScaler;
class Input;
class CML;
class DelayModuleEvr;

enum TSSource {
  TSSourceInternal=0,
  TSSourceEvent=1,
  TSSourceDBus4=2
};

class epicsShareClass EVR : public mrf::ObjectInst<EVR>
{
public:
  EVR(const std::string& n, bus_configuration& busConfig) : mrf::ObjectInst<EVR>(n), busConfiguration(busConfig) {}

  virtual ~EVR()=0;

  virtual std::string model() const=0;

  virtual MRFVersion version() const=0;
  std::string versionStr() const;
  virtual std::string versionSw() const;

  virtual std::string position() const;
  bus_configuration* getBusConfiguration();

  virtual bool enabled() const=0;
  virtual void enable(bool)=0;
  virtual bool mappedOutputState() const=0;

  virtual bool specialMapped(epicsUInt32 code, epicsUInt32 func) const=0;
  virtual void specialSetMap(epicsUInt32 code, epicsUInt32 func,bool set)=0;


  virtual double clock() const=0;
  virtual void clockSet(double clk)=0;

  virtual bool pllLocked() const=0;

  virtual epicsUInt32 uSecDiv() const=0;
  virtual bool extInhib() const=0;
  virtual void setExtInhib(bool)=0;

  virtual void setSourceTS(TSSource)=0;
  virtual TSSource SourceTS() const=0;

  virtual double clockTS() const=0;
  virtual void clockTSSet(double)=0;

  virtual epicsUInt32 tsDiv() const=0;

  virtual bool interestedInEvent(epicsUInt32 event,bool set)=0;


  virtual bool TimeStampValid() const=0;
  virtual IOSCANPVT TimeStampValidEvent() const=0;

  virtual bool getTimeStamp(epicsTimeStamp *ts,epicsUInt32 event)=0;

  virtual bool getTicks(epicsUInt32 *tks)=0;

  virtual IOSCANPVT eventOccurred(epicsUInt32 event) const=0;

  typedef void (*eventCallback)(void* userarg, epicsUInt32 event);
  virtual void eventNotifyAdd(epicsUInt32 event, eventCallback, void*)=0;
  virtual void eventNotifyDel(epicsUInt32 event, eventCallback, void*)=0;
  virtual epicsUInt32 irqCount() const=0;

  virtual bool linkStatus() const=0;
  virtual IOSCANPVT linkChanged() const=0;
  virtual epicsUInt32 recvErrorCount() const=0;
  virtual epicsUInt16 dbus() const=0;

  virtual epicsUInt32 heartbeatTIMOCount() const=0;
  virtual IOSCANPVT heartbeatTIMOOccured() const=0;

  virtual epicsUInt32 FIFOFullCount() const=0;
  virtual epicsUInt32 FIFOOverRate() const=0;
  virtual epicsUInt32 FIFOEvtCount() const=0;
  virtual epicsUInt32 FIFOLoopCount() const=0;


  void setSourceTSraw(epicsUInt32 r){setSourceTS((TSSource)r);};
  epicsUInt32 SourceTSraw() const{return (TSSource)SourceTS();};
private:
  bus_configuration busConfiguration;
}; // class EVR

#endif // EVR_HPP_INC