environment_card.h

Go to the documentation of this file.

#ifndef ENVIRONMENT_CARD_H
#define ENVIRONMENT_CARD_H

#include "dae2_card.h"

class EnvironmentCardIntf : public DAE2CardIntf
{
public:
        virtual int startRun(DAEstatus& status) = 0;
        virtual int stopRun(DAEstatus& status) = 0;
        virtual int ClearFramesAndPPP(DAEstatus& status) = 0;
        virtual int setFrameSync(FrameSync fs, DAEstatus& status) = 0;
        virtual bool isRunning(DAEstatus& status) = 0;
        virtual void printStatus(std::ostream& os, DAEstatus& status) = 0;
        virtual int resetRunController(DAEstatus& status) = 0;
//      int getRawFramesLower(isisU16_t* value, DAEstatus& status);
//      int getRawFramesUpper(isisU16_t* value, DAEstatus& status);
        virtual int getRawFrames(isisU32_t* value, DAEstatus& status) = 0;
//      int getGoodFramesLower(isisU16_t* value, DAEstatus& status);
//      int getGoodFramesUpper(isisU16_t* value, DAEstatus& status);
        virtual int getGoodFrames(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getRawPPPLower(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getRawPPPUpper(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getRawPPP(isisU64_t* value, DAEstatus& status) = 0;
        virtual int getGoodPPPLower(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getGoodPPPUpper(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getGoodPPP(isisU64_t* value, DAEstatus& status) = 0;
        virtual int enableSMPVeto(DAEstatus& status) = 0;
        virtual int enableTS2PulseVeto(DAEstatus& status) = 0;
        virtual int enableISIS50HzVeto(DAEstatus& status) = 0;
        virtual int enableExternalVeto(int veto_number, DAEstatus& status) = 0;
        virtual int enableInternalVeto(DAEstatus& status) = 0;
        virtual int enableFIFOVeto(DAEstatus& status) = 0;
        virtual int enableHardwarePeriods(DAEstatus& status) = 0; 
    virtual int disableHardwarePeriods(DAEstatus& status) = 0; 
        virtual int disableSMPVeto(DAEstatus& status) = 0;
        virtual int disableExternalVeto(int veto_number, DAEstatus& status) = 0;
        virtual int disableInternalVeto(DAEstatus& status) = 0;
        virtual int disableFIFOVeto(DAEstatus& status) = 0;
        virtual int disableTS2PulseVeto(DAEstatus& status) = 0;
        virtual int disableISIS50HzVeto(DAEstatus& status) = 0;
        virtual int getSMPVetoedFrames(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getExternalVetoedFrames(int veto_number, isisU32_t* value, DAEstatus& status) = 0;
        virtual int getFIFOVetoedFrames(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getTS2PulseVetoedFrames(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getISIS50HzVetoedFrames(isisU32_t* value, DAEstatus& status) = 0;
        virtual int clearSMPVetoedFrames(DAEstatus& status) = 0;
        virtual int clearExternalVetoedFrames(DAEstatus& status) = 0;
        virtual int clearFIFOVetoedFrames(DAEstatus& status) = 0;
        virtual int setFrameSyncDelay(isisU32_t value, DAEstatus& status) = 0;                  // in us
        virtual int getFrameSyncDelay(isisU32_t* value, DAEstatus& status) = 0;                 // in us
        virtual float getRawUAmpHours(DAEstatus& status) = 0;
        virtual float getGoodUAmpHours(DAEstatus& status) = 0;
        virtual bool usingHardwarePeriods(DAEstatus& status) = 0;
        EnvironmentCardIntf() { }
        virtual ~EnvironmentCardIntf() { }

        virtual int getFChopperVetoedFrames(int chopper_number, isisU32_t* value, DAEstatus& status) = 0;
        virtual int enableFChopperVeto(int chopper_number, int delay, int width, DAEstatus& status) = 0;  // in 20ns units
        virtual int disableFChopperVeto(int chopper_number, DAEstatus& status) = 0;
        virtual int printVetoDetails(std::ostream& os, DAEstatus& status) = 0;
        virtual int whichVeto(std::ostream& os, DAEstatus& status) = 0;

        virtual int resetCardState(DAEstatus& status) = 0;

};

template <class EnvPeriodPolicy>
class EnvironmentCard : public DAE2Card<EnvPeriodPolicy>, public EnvironmentCardIntf
{

public:
        int startRun(DAEstatus& status);
        int stopRun(DAEstatus& status);
        int ClearFramesAndPPP(DAEstatus& status);
        int setFrameSync(FrameSync fs, DAEstatus& status);
        bool isRunning(DAEstatus& status);
        void printStatus(std::ostream& os, DAEstatus& status);
        int resetRunController(DAEstatus& status);
//      int getRawFramesLower(isisU16_t* value, DAEstatus& status);
//      int getRawFramesUpper(isisU16_t* value, DAEstatus& status);
        int getRawFrames(isisU32_t* value, DAEstatus& status);
//      int getGoodFramesLower(isisU16_t* value, DAEstatus& status);
//      int getGoodFramesUpper(isisU16_t* value, DAEstatus& status);
        int getGoodFrames(isisU32_t* value, DAEstatus& status);
        int getRawPPPLower(isisU32_t* value, DAEstatus& status);
        int getRawPPPUpper(isisU32_t* value, DAEstatus& status);
        int getRawPPP(isisU64_t* value, DAEstatus& status);
        int getGoodPPPLower(isisU32_t* value, DAEstatus& status);
        int getGoodPPPUpper(isisU32_t* value, DAEstatus& status);
        int getGoodPPP(isisU64_t* value, DAEstatus& status);
        int enableSMPVeto(DAEstatus& status);
        int enableTS2PulseVeto(DAEstatus& status);
        int enableISIS50HzVeto(DAEstatus& status);
        int enableExternalVeto(int veto_number, DAEstatus& status);
        int enableInternalVeto(DAEstatus& status);
        int enableFIFOVeto(DAEstatus& status);
        int enableHardwarePeriods(DAEstatus& status); 
    int disableHardwarePeriods(DAEstatus& status); 
        int disableSMPVeto(DAEstatus& status);
        int disableExternalVeto(int veto_number, DAEstatus& status);
        int disableInternalVeto(DAEstatus& status);
        int disableFIFOVeto(DAEstatus& status);
        int disableTS2PulseVeto(DAEstatus& status);
        int disableISIS50HzVeto(DAEstatus& status);
        int getSMPVetoedFrames(isisU32_t* value, DAEstatus& status);
        int getExternalVetoedFrames(int veto_number, isisU32_t* value, DAEstatus& status);
        int getFIFOVetoedFrames(isisU32_t* value, DAEstatus& status);
        int getTS2PulseVetoedFrames(isisU32_t* value, DAEstatus& status);
        int getISIS50HzVetoedFrames(isisU32_t* value, DAEstatus& status);
        int clearSMPVetoedFrames(DAEstatus& status);
        int clearExternalVetoedFrames(DAEstatus& status);
        int clearFIFOVetoedFrames(DAEstatus& status);
        int setFrameSyncDelay(isisU32_t value, DAEstatus& status);                      // in us
        int getFrameSyncDelay(isisU32_t* value, DAEstatus& status);                     // in us
        float getRawUAmpHours(DAEstatus& status);
        float getGoodUAmpHours(DAEstatus& status);
        bool usingHardwarePeriods(DAEstatus& status);
        EnvironmentCard(int position, ISISVME* vme, DAEstatus& status);

        int getFChopperVetoedFrames(int chopper_number, isisU32_t* value, DAEstatus& status);
        int enableFChopperVeto(int chopper_number, int delay, int width, DAEstatus& status);  // in 20ns units
        int disableFChopperVeto(int chopper_number, DAEstatus& status);
        int printVetoDetails(std::ostream& os, DAEstatus& status);
        int whichVeto(std::ostream& os, DAEstatus& status);

        virtual int resetCardState(DAEstatus& status);

        virtual int position() const { return DAE2Card<EnvPeriodPolicy>::position(); }
        virtual std::string daeDevice() const  { return DAE2Card<EnvPeriodPolicy>::daeDevice(); }

protected:
        enum EnvironmentCardOptions { None=0x0, FChopperVeto=0x1 };
        CardOptions m_options;

        int setVetoRegisterBits(isisU32_t mask, bool preserve, DAEstatus& status);
        int clearVetoRegisterBits(isisU32_t mask, DAEstatus& status);

        int setRunControlBits(isisU32_t mask, bool preserve, DAEstatus& status);
        int clearRunControlBits(isisU32_t mask, DAEstatus& status);
        int setAndClearRunControlBits(isisU32_t mask, bool preserve, DAEstatus& status);
        int clearPPP(DAEstatus& status);
};

#endif /* ENVIRONMENT_CARD_H */