m2kanalogin.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 M2KANALOGIN_HPP
#define M2KANALOGIN_HPP

#include <libm2k/m2kglobal.hpp>
#include <libm2k/analog/enums.hpp>
#include <libm2k/m2khardwaretrigger.hpp>
#include <vector>
#include <map>
#include <memory>

namespace libm2k {
namespace analog {
class LIBM2K_API M2kAnalogIn
{
public:
    virtual ~M2kAnalogIn() {}

    virtual void reset() = 0;

    virtual void startAcquisition(unsigned int nb_samples) = 0;


    virtual void stopAcquisition() = 0;


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


    virtual std::vector<std::vector<double>> getSamplesRaw(unsigned int nb_samples) = 0;


    virtual const double* getSamplesInterleaved(unsigned int nb_samples_per_channel) = 0;


    virtual const short* getSamplesRawInterleaved(unsigned int nb_samples_per_channel) = 0;


    virtual const double* getSamplesInterleaved_matlab(unsigned int nb_samples) = 0;


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


    virtual short getVoltageRaw(unsigned int ch) = 0;


    virtual double getVoltage(unsigned int ch) = 0;


    virtual short getVoltageRaw(libm2k::analog::ANALOG_IN_CHANNEL ch) = 0;


    virtual double getVoltage(libm2k::analog::ANALOG_IN_CHANNEL ch) = 0;


    virtual std::vector<short> getVoltageRaw() = 0;


    virtual std::vector<double> getVoltage() = 0;


    virtual const short *getVoltageRawP() = 0;


    virtual const double *getVoltageP() = 0;

    virtual void setVerticalOffset(ANALOG_IN_CHANNEL channel, double vertOffset) = 0;

    virtual double getVerticalOffset(ANALOG_IN_CHANNEL channel) = 0;


    virtual double getScalingFactor(libm2k::analog::ANALOG_IN_CHANNEL ch) = 0;


    virtual void setRange(ANALOG_IN_CHANNEL channel, M2K_RANGE range) = 0;


    virtual void setRange(ANALOG_IN_CHANNEL channel, double min, double max) = 0;


    virtual libm2k::analog::M2K_RANGE getRange(libm2k::analog::ANALOG_IN_CHANNEL channel) = 0;


    virtual std::pair<double, double> getRangeLimits(libm2k::analog::M2K_RANGE range) = 0;


    virtual std::vector<std::pair<std::string, std::pair<double, double>>> getAvailableRanges() = 0;


    virtual int getOversamplingRatio() = 0;


    virtual int getOversamplingRatio(unsigned int chn_idx) = 0;


    virtual int setOversamplingRatio(int oversampling) = 0;


    virtual int setOversamplingRatio(unsigned int chn_idx, int oversampling) = 0;


    virtual double getSampleRate() = 0;


    virtual std::vector<double> getAvailableSampleRates() = 0;

    virtual double setSampleRate(double samplerate) = 0;


    virtual std::pair<double, double> getHysteresisRange(ANALOG_IN_CHANNEL chn) = 0;


    virtual double getFilterCompensation(double samplerate) = 0;


    virtual double getValueForRange(M2K_RANGE range) = 0;


    virtual double convertRawToVolts(unsigned int channel, short raw) = 0;


    virtual short convertVoltsToRaw(unsigned int channel, double voltage) = 0;


    virtual unsigned int getNbChannels() = 0;


    virtual std::string getName() = 0;


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


    virtual bool isChannelEnabled(unsigned int chnIdx) = 0;


    virtual void cancelAcquisition() = 0;


    virtual void setKernelBuffersCount(unsigned int count) = 0;

    virtual unsigned int getKernelBuffersCount() const = 0;


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

    virtual struct IIO_OBJECTS getIioObjects() = 0;


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

    virtual std::string getChannelName(unsigned int channel) = 0;

    virtual double getMaximumSamplerate() = 0;

};
}
}

#endif //M2KANALOGIN_HPP