/usr/include/wreport/vartable.h is in libwreport-dev 3.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 | #ifndef WREPORT_VARTABLE_H
#define WREPORT_VARTABLE_H
#include <wreport/varinfo.h>
#include <string>
#include <functional>
namespace wreport {
struct BufrTableID;
struct CrexTableID;
/**
* Holds a variable information table
*
* It never needs to be deallocated, as all the Vartable returned by
* wreport are pointers to memory-cached versions that are guaranteed to exist
* for all the lifetime of the program.
*
* There are many B tables with slight differences used by different
* meteorological centre or equipment. This module allows to access
* different vartables using Vartable::get().
*
* Vartable and Varinfo have special memory management: they are never
* deallocated. This is an explicit design choice to speed up passing and
* copying Varinfo values, that are used very intensely as they accompany all
* the physical values processed by wreport. This behaviour should not be a
* cause of memory leaks, since a software would only need to access a limited
* amount of distinct variable informations during its lifetime.
*/
struct Vartable
{
virtual ~Vartable();
/// Return the pathname of the file from which this table has been loaded
virtual std::string pathname() const = 0;
/**
* Query the Vartable. Throws an exception if not found.
*
* @param code
* wreport::Varcode to query
* @return
* the wreport::varinfo with the results of the query.
*/
virtual Varinfo query(Varcode code) const = 0;
/// Check if the code can be resolved to a varinfo
virtual bool contains(Varcode code) const = 0;
/**
* Query an altered version of the vartable
*
* @param var
* wreport::Varcode to query
* @param scale
* Scale to use instead of the default
* @param bit_len
* Bit length to use instead of the default
* @return
* the wreport::Varinfo with the results of the query.
* The resulting Varinfo is stored inside the Vartable, can be freely
* copied around and does not need to be deallocated.
*/
virtual Varinfo query_altered(Varcode code, int new_scale, unsigned new_bit_len) const = 0;
/**
* Iterate the whole contents of the table.
*
* Return false from dest to stop iteration.
*
* @returns true if iteration ended normally, false if dest returned false.
*/
virtual bool iterate(std::function<bool(Varinfo)> dest) const = 0;
/**
* Return a BUFR vartable, by file name.
*
* Once loaded, the table will be cached in memory for reuse, and
* further calls to load_bufr() will return the cached version.
*/
static const Vartable* load_bufr(const std::string& pathname);
/**
* Return a CREX vartable, by file name.
*
* Once loaded, the table will be cached in memory for reuse, and
* further calls to load_crex() will return the cached version.
*/
static const Vartable* load_crex(const std::string& pathname);
/// Find a BUFR table
static const Vartable* get_bufr(const BufrTableID& id);
/// Find a CREX table
static const Vartable* get_crex(const CrexTableID& id);
/// Find a BUFR table, by file name (without extension)
static const Vartable* get_bufr(const std::string& basename);
/// Find a CREX table, by file name (without extension)
static const Vartable* get_crex(const std::string& basename);
};
}
#endif
|