/usr/include/dballe/types.h is in libdballe-dev 7.21-1build1.
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 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 | #ifndef DBALLE_TYPES_H
#define DBALLE_TYPES_H
/** @file
* Common base types used by most of DB-All.e code.
*/
#include <iosfwd>
#include <limits.h>
namespace dballe {
struct CSVWriter;
/**
* Value to use for missing parts of level and time range values
*/
static constexpr int MISSING_INT = INT_MAX;
/**
* Calendar date.
*
* If year is 0xffff, then all the date is considered missing. Else, all fields
* must be set.
*/
struct Date
{
unsigned short year;
unsigned char month;
unsigned char day;
/// Construct a missing date
Date();
/**
* Construct from broken down values.
*
* A year of MISSING_INT constructs a missing Date. In any other case,
* arguments are validated with Date::validate().
*/
Date(int ye, int mo=1, int da=1);
/// Copy constructor
Date(const Date& d) = default;
/// Create a date from a Julian day
static Date from_julian(int jday);
/// Check if this date is the missing value
bool is_missing() const;
/// Convert the date to Julian day
int to_julian() const;
/**
* Write the date to an output stream in ISO8601 date format.
*/
void to_stream_iso8601(std::ostream& out) const;
/**
* Write the date as a CSV field in ISO8601 date format.
*/
void to_csv_iso8601(CSVWriter& out) const;
/**
* Generic comparison
*
* Returns a negative number if *this < other
* Returns zero if *this == other
* Returns a positive number if *this > other
*/
int compare(const Date& other) const;
bool operator<(const Date& dt) const;
bool operator>(const Date& dt) const;
bool operator==(const Date& dt) const;
bool operator!=(const Date& dt) const;
/// Raise an exception if the three values do not represent a valid date
static void validate(int ye, int mo, int da);
/// Return the number of days in the given month
static int days_in_month(int year, int month);
/// Convert a calendar date into a Julian day
static int calendar_to_julian(int year, int month, int day);
/// Convert a Julian day into a calendar date
static void julian_to_calendar(int jday, unsigned short& year, unsigned char& month, unsigned char& day);
};
/**
* Time of the day.
*
* If hour is 0xff, then all the time is considered missing. Else, all fields
* must be set.
*/
struct Time
{
unsigned char hour;
unsigned char minute;
unsigned char second;
/// Construct a missing time
Time();
/**
* Construct from broken down values.
*
* A hour of MISSING_INT constructs a missing Time. In any other case,
* arguments are validated with Time::validate().
*/
Time(int ho, int mi=0, int se=0);
Time(const Time& t) = default;
/// Check if this time is the missing value
bool is_missing() const;
/**
* Write the time to an output stream in ISO8601 extended format
* (hh:mm:ss).
*/
void to_stream_iso8601(std::ostream& out) const;
/**
* Write the time as a CSV field in ISO8601 date format.
*/
void to_csv_iso8601(CSVWriter& out) const;
/**
* Generic comparison
*
* Returns a negative number if *this < other
* Returns zero if *this == other
* Returns a positive number if *this > other
*/
int compare(const Time& other) const;
bool operator<(const Time& dt) const;
bool operator>(const Time& dt) const;
bool operator==(const Time& dt) const;
bool operator!=(const Time& dt) const;
/**
* Raise an exception if the three values do not represent a valid time.
*
* A value of 23:59:60 is allowed to accomodate for times during leap
* seconds.
*/
static void validate(int ho, int mi, int se);
};
/**
* Date and time
*
* If year is 0xffff, then all the datetime is considered missing. Else, all
* fields must be set.
*/
struct Datetime
{
unsigned short year;
unsigned char month;
unsigned char day;
unsigned char hour;
unsigned char minute;
unsigned char second;
/// Construct a missing datetime
Datetime();
Datetime(const Date& date, const Time& time);
/**
* Construct from broken down values.
*
* A year of MISSING_INT constructs a missing Datetime. In any other case,
* arguments are validated with Datetime::validate().
*/
Datetime(int ye, int mo=1, int da=1, int ho=0, int mi=0, int se=0);
/// Set the date from a Julian day
static Datetime from_julian(int jday, int ho=0, int mi=0, int se=0);
/**
* Return a Datetime filling the parts set to MISSING_INT with their lowest
* possible values
*/
static Datetime lower_bound(int ye, int mo, int da, int ho, int mi, int se);
/**
* Return a Datetime filling the parts set to MISSING_INT with their
* highest possible values
*/
static Datetime upper_bound(int ye, int mo, int da, int ho, int mi, int se);
/// Return a Date with this date
Date date() const;
/// Return a Time with this time
Time time() const;
/// Check if this datetime is the missing value
bool is_missing() const;
/// Convert the date to Julian day
int to_julian() const;
/**
* Generic comparison
*
* Returns a negative number if *this < other
* Returns zero if *this == other
* Returns a positive number if *this > other
*/
int compare(const Datetime& other) const;
bool operator==(const Datetime& dt) const;
bool operator!=(const Datetime& dt) const;
bool operator<(const Datetime& dt) const;
bool operator>(const Datetime& dt) const;
bool operator<=(const Datetime& dt) const;
bool operator>=(const Datetime& dt) const;
/**
* Print to an output stream in ISO8601 combined format.
*/
int print_iso8601(FILE* out, char sep='T', const char* end="\n") const;
/**
* Write the datetime to an output stream in ISO8601 combined format.
*
* @param out the output stream
* @param sep the separator character between date and time
* @param tz the timezone string to use at the end of the datetime
*/
void to_stream_iso8601(std::ostream& out, char sep='T', const char* tz="") const;
/**
* Write the datetime as a CSV field in ISO8601 date format.
*/
void to_csv_iso8601(CSVWriter& out, char sep='T', const char* tz="") const;
/**
* Parse an ISO8601 datetime string.
*
* Both 'T' and ' ' are allowed as separators.
*/
static Datetime from_iso8601(const char* str);
/**
* Raise an exception if the three values do not represent a valid
* date/time.
*
* A value of 23:59:60 is allowed to accomodate for times during leap
* seconds, but no effort is made to check if there has been a leap second
* on the given date.
*/
static void validate(int ye, int mo, int da, int ho, int mi, int se);
/**
* Convert a datetime with an hour of 24:00:00 to hour 00:00:00 of the
* following day.
*/
static void normalise_h24(int& ye, int& mo, int& da, int& ho, int& mi, int& se);
};
/**
* Range of datetimes.
*
* The range includes the extremes. A missing extreme in the range means an
* open ended range.
*/
struct DatetimeRange
{
/// Lower bound of the range
Datetime min;
/// Upper bound of the range
Datetime max;
DatetimeRange() = default;
DatetimeRange(const Datetime& min, const Datetime& max) : min(min), max(max) {}
DatetimeRange(
int yemin, int momin, int damin, int homin, int mimin, int semin,
int yemax, int momax, int damax, int homax, int mimax, int semax);
/// Check if this range is open on both sides
bool is_missing() const;
bool operator==(const DatetimeRange& dtr) const;
bool operator!=(const DatetimeRange& dtr) const;
/// Set the extremes
void set(const Datetime& min, const Datetime& max);
/**
* Set the extremes from broken down components.
*
* If yemin or yemax are MISSING_INT, they are taken as an open ended range
* boundary.
*
* If any other *min values are MISSING_INT, they are filled with the
* lowest possible valid value they can have.
*
* If any other *max values are MISSING_INT, they are filled with the
* highest possible valid value they can have.
*/
void set(int yemin, int momin, int damin, int homin, int mimin, int semin,
int yemax, int momax, int damax, int homax, int mimax, int semax);
/**
* Merge \a range into this one, resulting in the smallest range that
* contains both.
*/
void merge(const DatetimeRange& range);
/// Check if a Datetime is inside this range
bool contains(const Datetime& dt) const;
/// Check if a range is inside this range (extremes included)
bool contains(const DatetimeRange& dtr) const;
/// Check if the two ranges are completely disjoint
bool is_disjoint(const DatetimeRange& dtr) const;
};
/**
* Coordinates
*
* When given as an integer, a latitude/longitude value is intended in 1/100000
* of a degree, which is the maximum resolution supported by DB-All.e.
*
* When given as a double a latitude/longitude value is intended to be in
* degrees.
*
* Longitude values are normalized between -180.0 and 180.0.
*/
struct Coords
{
/// Latitude in 1/100000 of a degree (5 significant digits preserved)
int lat;
/**
* Longitude in 1/100000 of a degree (5 significant digits preserved) and
* normalised between -180.0 and 180.0.
*/
int lon;
/// Construct a missing Coords
Coords();
/// Construct a coords from integers in 1/100000 of a degree
Coords(int lat, int lon);
/// Construct a coords from values in degrees
Coords(double lat, double lon);
/// Check if these coordinates are undefined
bool is_missing() const;
/// Set from integers in 1/100000 of a degree
void set(int lat, int lon);
/// Set from values in degrees
void set(double lat, double lon);
/// Get the latitude in degrees
double dlat() const;
/// Get the longitude in degrees
double dlon() const;
/**
* Compare two Coords strutures, for use in sorting.
*
* Sorting happens by latitude first, then by longitude. It is implemented
* mainly for the purpose of being able to use Coords as a key in a sorted
* container.
*
* @return
* -1 if *this < o, 0 if *this == o, 1 if *this > o
*/
int compare(const Coords& o) const;
bool operator==(const Coords& dt) const;
bool operator!=(const Coords& dt) const;
bool operator<(const Coords& dt) const;
bool operator>(const Coords& dt) const;
bool operator<=(const Coords& dt) const;
bool operator>=(const Coords& dt) const;
/// Print to an output stream
int print(FILE* out, const char* end="\n") const;
};
/**
* Range of latitudes.
*
* When given as an integer, a latitude value is intended in 1/100000 of a
* degree, which is the maximum resolution supported by DB-All.e.
*
* When given as a double a latitude value is intended to be in degrees.
*
* Values are matched between imin and imax, both extremes are considered part
* of the range.
*
* Invariant: imin <= imax.
*/
struct LatRange
{
/// Minimum possible integer value
static constexpr int IMIN = -9000000;
/// Maximum possible integer value
static constexpr int IMAX = 9000000;
/// Minimum possible double value
static constexpr double DMIN = -90.0;
/// Maximum possible double value
static constexpr double DMAX = 90.0;
/// Minimum latitude
int imin = IMIN;
/// Maximum latitude
int imax = IMAX;
/// Construct a LatRange matching any latitude
LatRange() = default;
/// Construct a LatRange given integer extremes
LatRange(int min, int max);
/// Construct a LatRange given extremes in degrees
LatRange(double min, double max);
bool operator==(const LatRange& lr) const;
bool operator!=(const LatRange& lr) const;
/// Return true if the LatRange matches any latitude
bool is_missing() const;
/// Get the lower extreme as double
double dmin() const;
/// Get the upper extreme as double
double dmax() const;
/// Get the extremes as double
void get(double& min, double& max) const;
/// Set the extremes as integers
void set(int min, int max);
/// Set the extremes in degrees
void set(double min, double max);
/// Check if a point is inside this range (extremes included)
bool contains(int lat) const;
/// Check if a point is inside this range (extremes included)
bool contains(double lat) const;
/// Check if a range is inside this range (extremes included)
bool contains(const LatRange& lr) const;
};
/**
* Range of longitudes.
*
* When given as an integer, a longitude value is intended in 1/100000 of a
* degree, which is the maximum resolution supported by DB-All.e.
*
* When given as a double a longitude value is intended to be in degrees.
*
* Longitude values are normalized between -180.0 and 180.0. The range is the
* angle that goes from imin to imax. Both extremes are considered part of the
* range.
*
* A range that matches any longitude has both imin and imax set to
* MISSING_INT.
*
* Invariant: if imin == MISSING_INT, then imax == MISSING_INT. An open-ended
* longitude range makes no sense, since longitudes move alongide a closed
* circle.
*/
struct LonRange
{
/// Initial point of the longitude range
int imin = MISSING_INT;
/// Final point of the longitude range
int imax = MISSING_INT;
/// Construct a range that matches any longitude
LonRange() = default;
/// Construct a range given integer extremes
LonRange(int min, int max);
/// Construct a range given extremes in degrees
LonRange(double min, double max);
bool operator==(const LonRange& lr) const;
bool operator!=(const LonRange& lr) const;
/// Return true if the LonRange matches any longitude
bool is_missing() const;
/// Get the lower extreme as double, or -180.0 if missing
double dmin() const;
/// Get the upper extreme as double, or 180.0 if missing
double dmax() const;
/**
* Get the extremes in degrees.
*
* If is_missing() == true, it returns the values -180.0 and 180.0
*/
void get(double& min, double& max) const;
/// Set the extremes as integers
void set(int min, int max);
/// Set the extremes in degrees
void set(double min, double max);
/// Check if a point is inside this range (extremes included)
bool contains(int lon) const;
/// Check if a point is inside this range (extremes included)
bool contains(double lon) const;
/// Check if a range is inside this range (extremes included)
bool contains(const LonRange& lr) const;
};
/// Vertical level or layer
struct Level
{
/// Type of the level or the first layer. See @ref level_table.
int ltype1;
/// L1 value of the level or the first layer. See @ref level_table.
int l1;
/// Type of the the second layer. See @ref level_table.
int ltype2;
/// L2 value of the second layer. See @ref level_table.
int l2;
Level(int ltype1=MISSING_INT, int l1=MISSING_INT, int ltype2=MISSING_INT, int l2=MISSING_INT)
: ltype1(ltype1), l1(l1), ltype2(ltype2), l2(l2) {}
/// Check if this level is fully set to the missing value
bool is_missing() const;
bool operator==(const Level& l) const;
bool operator!=(const Level& l) const;
bool operator<(const Level& l) const;
bool operator>(const Level& l) const;
/**
* Generic comparison
*
* Returns a negative number if *this < other
* Returns zero if *this == other
* Returns a positive number if *this > other
*/
int compare(const Level& l) const;
/**
* Return a string description of this level
*/
std::string describe() const;
/// Format to an output stream
void to_stream(std::ostream& out, const char* undef="-") const;
/**
* Write the datetime to a CSV writer as 4 fields
*/
void to_csv(CSVWriter& out) const;
/// Create a cloud special level. See @ref level_table.
static Level cloud(int ltype2=MISSING_INT, int l2=MISSING_INT);
/// Print to an output stream
int print(FILE* out, const char* undef="-", const char* end="\n") const;
};
/**
* Information on how a value has been sampled or computed with regards to time.
*/
struct Trange
{
/// Time range type indicator.
int pind;
/// Time range P1 indicator.
int p1;
/// Time range P2 indicator.
int p2;
Trange(int pind=MISSING_INT, int p1=MISSING_INT, int p2=MISSING_INT)
: pind(pind), p1(p1), p2(p2) {}
/// Check if this level is fully set to the missing value
bool is_missing() const;
/**
* Generic comparison
*
* Returns a negative number if *this < other
* Returns zero if *this == other
* Returns a positive number if *this > other
*/
int compare(const Trange& t) const;
bool operator==(const Trange& tr) const;
bool operator!=(const Trange& tr) const;
bool operator<(const Trange& t) const;
bool operator>(const Trange& t) const;
/**
* Return a string description of this time range
*/
std::string describe() const;
/// Format to an output stream
void to_stream(std::ostream& out, const char* undef="-") const;
/**
* Write the datetime to a CSV writer as 3 fields
*/
void to_csv(CSVWriter& out) const;
/// Time range for instant values
static Trange instant();
/// Print to an output stream
int print(FILE* out, const char* undef="-", const char* end="\n") const;
};
}
#endif
|