m2khardwaretrigger.hpp

/*
 * Copyright (c) 2019 Analog Devices Inc.
 *
 * This file is part of libm2k
 * (see http://www.github.com/analogdevicesinc/libm2k).
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef M2KHARDWARETRIGGER_HPP
#define M2KHARDWARETRIGGER_HPP

#include <libm2k/enums.hpp>
#include <libm2k/digital/enums.hpp>
#include <libm2k/m2kglobal.hpp>
#include <libm2k/m2k.hpp>
#include <vector>
#include <memory>

namespace libm2k {

class LIBM2K_API M2kHardwareTrigger
{
public:
    virtual ~M2kHardwareTrigger() {}


    virtual void reset() = 0;

    virtual int getAnalogLevelRaw(unsigned int chnIdx) = 0;


    virtual void setAnalogLevelRaw(unsigned int chnIdx, int level) = 0;


    virtual void setAnalogLevel(unsigned int chnIdx, double v_level) = 0;


    virtual double getAnalogLevel(unsigned int chnIdx) = 0;


    virtual double getAnalogHysteresis(unsigned int chnIdx) = 0;


    virtual void setAnalogHysteresis(unsigned int chnIdx, double hysteresis) = 0;


    virtual M2K_TRIGGER_CONDITION_ANALOG getAnalogCondition(unsigned int chnIdx) = 0;


    virtual void setAnalogCondition(unsigned int chnIdx, M2K_TRIGGER_CONDITION_ANALOG cond) = 0;


    virtual M2K_TRIGGER_CONDITION_DIGITAL getDigitalCondition(unsigned int chnIdx) = 0;


    virtual M2K_TRIGGER_CONDITION_DIGITAL getDigitalCondition(libm2k::digital::DIO_CHANNEL chnIdx) = 0;


    virtual void setDigitalCondition(unsigned int chnIdx, M2K_TRIGGER_CONDITION_DIGITAL cond) = 0;


    virtual void setDigitalCondition(libm2k::digital::DIO_CHANNEL chnIdx, M2K_TRIGGER_CONDITION_DIGITAL cond) = 0;



    virtual M2K_TRIGGER_MODE getAnalogMode(unsigned int chnIdx) = 0;


    virtual void setAnalogMode(unsigned int chnIdx, M2K_TRIGGER_MODE mode) = 0;


    virtual libm2k::digital::DIO_TRIGGER_MODE getDigitalMode() = 0;


    virtual void setDigitalMode(libm2k::digital::DIO_TRIGGER_MODE mode) = 0;


    virtual M2K_TRIGGER_SOURCE_ANALOG getAnalogSource() = 0;


    virtual void setAnalogSource(M2K_TRIGGER_SOURCE_ANALOG src) = 0;


    virtual int getAnalogSourceChannel() = 0;


    virtual void setAnalogSourceChannel(unsigned int chnIdx) = 0;


    virtual int getAnalogDelay() const = 0;


    virtual void setAnalogDelay(int delay) = 0;


    virtual int getDigitalDelay() const = 0;


    virtual void setDigitalDelay(int delay) = 0;


    virtual struct SETTINGS *getCurrentHwSettings() = 0;


    virtual void setHwTriggerSettings(struct SETTINGS *settings) = 0;


    virtual void setAnalogStreamingFlag(bool enable) = 0;


    virtual bool getAnalogStreamingFlag() = 0;


    virtual void setDigitalStreamingFlag(bool enable) = 0;


    virtual bool getDigitalStreamingFlag() = 0;


    virtual void setCalibParameters(unsigned int chnIdx, double scaling, double vert_offset) = 0;


    virtual M2K_TRIGGER_CONDITION_DIGITAL getAnalogExternalCondition(unsigned int chnIdx) = 0;


    virtual void setAnalogExternalCondition(unsigned int chnIdx, M2K_TRIGGER_CONDITION_DIGITAL cond) = 0;


    virtual M2K_TRIGGER_CONDITION_DIGITAL getDigitalExternalCondition() const = 0;


    virtual void setDigitalExternalCondition(M2K_TRIGGER_CONDITION_DIGITAL cond) = 0;


    virtual void setAnalogExternalOutSelect(M2K_TRIGGER_OUT_SELECT output_select);


    virtual M2K_TRIGGER_OUT_SELECT getAnalogExternalOutSelect();


    virtual bool hasExternalTriggerIn() const = 0;


    virtual bool hasExternalTriggerOut() const = 0;


    virtual bool hasCrossInstrumentTrigger() const = 0;


    virtual void setDigitalSource(M2K_TRIGGER_SOURCE_DIGITAL external_src);


    virtual M2K_TRIGGER_SOURCE_DIGITAL getDigitalSource() const;


    virtual void setAnalogOutTriggerSource(M2K_TRIGGER_SOURCE_OUT src) = 0;


    virtual M2K_TRIGGER_SOURCE_OUT getAnalogOutTriggerSource() const = 0;


    virtual void setAnalogOutTriggerCondition(M2K_TRIGGER_CONDITION_OUT condition) = 0;


    virtual M2K_TRIGGER_CONDITION_OUT getAnalogOutTriggerCondition() const = 0;

    virtual void setAnalogOutTriggerStatus(M2K_TRIGGER_STATUS_ANALOG_OUT status) = 0;


    virtual M2K_TRIGGER_STATUS_ANALOG_OUT getAnalogOutTriggerStatus() const = 0;
};
}

#endif //M2KHARDWARETRIGGER_HPP