Types.hpp

Go to the documentation of this file.

#pragma once
#include <SoapySDR/Config.hpp>
#include <SoapySDR/Types.h>
#include <vector>
#include <string>
#include <map>

namespace SoapySDR
{

typedef std::map<std::string, std::string> Kwargs;

SOAPY_SDR_API Kwargs KwargsFromString(const std::string &markup);

SOAPY_SDR_API std::string KwargsToString(const Kwargs &args);

typedef std::vector<Kwargs> KwargsList;

class SOAPY_SDR_API Range
{
public:

    Range(void);

    Range(const double minimum, const double maximum, const double step=0.0);

    double minimum(void) const;

    double maximum(void) const;

    double step(void) const;

private:
    double _min, _max, _step;
};

typedef std::vector<Range> RangeList;

class SOAPY_SDR_API ArgInfo
{
public:

    ArgInfo(void);

    std::string key;

    std::string value;

    std::string name;

    std::string description;

    std::string units;

    enum Type {BOOL, INT, FLOAT, STRING} type;

    Range range;

    std::vector<std::string> options;

    std::vector<std::string> optionNames;
};

typedef std::vector<ArgInfo> ArgInfoList;

}

inline double SoapySDR::Range::minimum(void) const
{
    return _min;
}

inline double SoapySDR::Range::maximum(void) const
{
    return _max;
}

inline double SoapySDR::Range::step(void) const
{
    return _step;
}