m2kdigital.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 M2KDIGITAL_HPP
#define M2KDIGITAL_HPP

#include <libm2k/m2kglobal.hpp>
#include <libm2k/digital/enums.hpp>
#include <libm2k/analog/enums.hpp>
#include <libm2k/m2khardwaretrigger.hpp>
#include <string>
#include <vector>

namespace libm2k {

namespace digital {


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


    virtual void reset() = 0;


    virtual void setDirection(unsigned short mask) = 0;


    virtual void setDirection(unsigned int index, DIO_DIRECTION dir) = 0;


    virtual void setDirection(unsigned int index, bool dir) = 0;


    virtual void setDirection(DIO_CHANNEL index, bool dir) = 0;


    virtual void setDirection(DIO_CHANNEL index, DIO_DIRECTION dir) = 0;


    virtual DIO_DIRECTION getDirection(DIO_CHANNEL index) = 0;


    virtual void setValueRaw(DIO_CHANNEL index, DIO_LEVEL level) = 0;


    virtual void push(std::vector<unsigned short> const &data) = 0;


    virtual void push(unsigned short *data, unsigned int nb_samples) = 0;


    virtual void setValueRaw(unsigned int index, DIO_LEVEL level) = 0;


    virtual void setValueRaw(DIO_CHANNEL index, bool level) = 0;


    virtual DIO_LEVEL getValueRaw(DIO_CHANNEL index) = 0;


    virtual DIO_LEVEL getValueRaw(unsigned int index) = 0;


    virtual void stopBufferOut() = 0;

    virtual void startAcquisition(unsigned int nb_samples) = 0;


    virtual void stopAcquisition() = 0;


    virtual void cancelAcquisition() = 0;

    virtual void cancelBufferOut() = 0;


    virtual std::vector<unsigned short> getSamples(unsigned int nb_samples) = 0;

    virtual const unsigned short *getSamplesP(unsigned int nb_samples) = 0;

    /* Enable/disable TX channels only*/


    virtual void enableChannel(unsigned int index, bool enable) = 0;


    virtual void enableChannel(DIO_CHANNEL index, bool enable) = 0;


    virtual void enableAllOut(bool enable) = 0;


    virtual bool anyChannelEnabled(DIO_DIRECTION dir) = 0;


    virtual void setOutputMode(DIO_CHANNEL chn, DIO_MODE mode) = 0;


    virtual void setOutputMode(unsigned int chn, DIO_MODE mode) = 0;


    virtual DIO_MODE getOutputMode(DIO_CHANNEL chn) = 0;


    virtual DIO_MODE getOutputMode(unsigned int chn) = 0;


    virtual double setSampleRateIn(double samplerate) = 0;


    virtual double setSampleRateOut(double samplerate) = 0;


    virtual double getSampleRateIn() = 0;


    virtual double getSampleRateOut() = 0;


    virtual bool getCyclic() = 0;


    virtual void setCyclic(bool cyclic) = 0;


    virtual libm2k::M2kHardwareTrigger* getTrigger() = 0;


    virtual void setKernelBuffersCountIn(unsigned int count) = 0;


    virtual void setKernelBuffersCountOut(unsigned int count) = 0;


    virtual struct IIO_OBJECTS getIioObjects() = 0;


    virtual unsigned int getNbChannelsIn() = 0;


    virtual unsigned int getNbChannelsOut() = 0;


    virtual void getSamples(std::vector<unsigned short> &data, unsigned int nb_samples) = 0;


    virtual void setRateMux() = 0;


    virtual void resetRateMux() = 0;

    virtual void setExternalClocksource(bool external) = 0;

    virtual bool isClocksourceExternal() = 0;
};
}
}
#endif //M2KDIGITAL_HPP