Loading...
Searching...
No Matches
ranges.h
Go to the documentation of this file.
//
// Copyright 2015 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
#pragma once
#include <uhd/config.h>
#include <uhd/error.h>
#include <stdbool.h>
#include <stdlib.h>
typedef struct
{
double start;
double stop;
double step;
} uhd_range_t;
#ifdef __cplusplus
# include <uhd/types/ranges.hpp>
# include <string>
struct uhd_meta_range_t
{
uhd::meta_range_t meta_range_cpp;
std::string last_error;
};
extern "C" {
#else
struct uhd_meta_range_t;
#endif
typedef struct uhd_meta_range_t* uhd_meta_range_handle;
UHD_API uhd_error uhd_range_to_pp_string(
const uhd_range_t* range, char* pp_string_out, size_t strbuffer_len);
UHD_API uhd_error uhd_meta_range_make(uhd_meta_range_handle* h);
UHD_API uhd_error uhd_meta_range_free(uhd_meta_range_handle* h);
UHD_API uhd_error uhd_meta_range_start(uhd_meta_range_handle h, double* start_out);
UHD_API uhd_error uhd_meta_range_stop(uhd_meta_range_handle h, double* stop_out);
UHD_API uhd_error uhd_meta_range_step(uhd_meta_range_handle h, double* step_out);
UHD_API uhd_error uhd_meta_range_clip(
uhd_meta_range_handle h, double value, bool clip_step, double* result_out);
UHD_API uhd_error uhd_meta_range_size(uhd_meta_range_handle h, size_t* size_out);
UHD_API uhd_error uhd_meta_range_push_back(
uhd_meta_range_handle h, const uhd_range_t* range);
UHD_API uhd_error uhd_meta_range_at(
uhd_meta_range_handle h, size_t num, uhd_range_t* range_out);
UHD_API uhd_error uhd_meta_range_to_pp_string(
uhd_meta_range_handle h, char* pp_string_out, size_t strbuffer_len);
UHD_API uhd_error uhd_meta_range_last_error(
uhd_meta_range_handle h, char* error_out, size_t strbuffer_len);
#ifdef __cplusplus
}
UHD_API uhd::range_t uhd_range_c_to_cpp(const uhd_range_t* range_c);
UHD_API void uhd_range_cpp_to_c(const uhd::range_t& range_cpp, uhd_range_t* range_c);
#endif
uhd::range_t
Definition ranges.hpp:22
config.h
UHD_API
#define UHD_API
Definition config.h:87
error.h
uhd_error
uhd_error
UHD error codes.
Definition error.h:20
uhd_meta_range_make
UHD_API uhd_error uhd_meta_range_make(uhd_meta_range_handle *h)
Create a meta range handle.
uhd_meta_range_to_pp_string
UHD_API uhd_error uhd_meta_range_to_pp_string(uhd_meta_range_handle h, char *pp_string_out, size_t strbuffer_len)
Get a string representation of the given meta range.
uhd_meta_range_free
UHD_API uhd_error uhd_meta_range_free(uhd_meta_range_handle *h)
Destroy a meta range handle.
uhd_meta_range_start
UHD_API uhd_error uhd_meta_range_start(uhd_meta_range_handle h, double *start_out)
Get the overall start value for the given meta range.
uhd_meta_range_at
UHD_API uhd_error uhd_meta_range_at(uhd_meta_range_handle h, size_t num, uhd_range_t *range_out)
Get the range at the given index.
uhd_meta_range_clip
UHD_API uhd_error uhd_meta_range_clip(uhd_meta_range_handle h, double value, bool clip_step, double *result_out)
Clip the given value to a possible value in the given range.
uhd_meta_range_stop
UHD_API uhd_error uhd_meta_range_stop(uhd_meta_range_handle h, double *stop_out)
Get the overall stop value for the given meta range.
uhd_meta_range_last_error
UHD_API uhd_error uhd_meta_range_last_error(uhd_meta_range_handle h, char *error_out, size_t strbuffer_len)
Get the last error recorded by the underlying meta range.
uhd_meta_range_push_back
UHD_API uhd_error uhd_meta_range_push_back(uhd_meta_range_handle h, const uhd_range_t *range)
Add a range to the given meta range.
uhd_range_to_pp_string
UHD_API uhd_error uhd_range_to_pp_string(const uhd_range_t *range, char *pp_string_out, size_t strbuffer_len)
Get a string representation of the given range.
uhd_meta_range_handle
struct uhd_meta_range_t * uhd_meta_range_handle
C-level interface for dealing with a list of ranges.
Definition ranges.h:46
uhd_meta_range_size
UHD_API uhd_error uhd_meta_range_size(uhd_meta_range_handle h, size_t *size_out)
Get the number of ranges in the given meta range.
uhd_meta_range_step
UHD_API uhd_error uhd_meta_range_step(uhd_meta_range_handle h, double *step_out)
Get the overall step value for the given meta range.
ranges.hpp
uhd::meta_range_t
Definition ranges.hpp:66
uhd_range_t
Range of floating-point values.
Definition ranges.h:18
uhd_range_t::stop
double stop
Last value.
Definition ranges.h:22
uhd_range_t::start
double start
First value.
Definition ranges.h:20
uhd_range_t::step
double step
Granularity.
Definition ranges.h:24