WPILibC++ 2023.4.3
time.h
Go to the documentation of this file.
1// Copyright (c) FIRST and other WPILib contributors.
2// Open Source Software; you can modify and/or share it under the terms of
3// the WPILib BSD license file in the root directory of this project.
4
5// Copyright (c) 2016 Nic Holthaus
6//
7// The MIT License (MIT)
8//
9// Permission is hereby granted, free of charge, to any person obtaining a copy
10// of this software and associated documentation files (the "Software"), to deal
11// in the Software without restriction, including without limitation the rights
12// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13// copies of the Software, and to permit persons to whom the Software is
14// furnished to do so, subject to the following conditions:
15//
16// The above copyright notice and this permission notice shall be included in
17// all copies or substantial portions of the Software.
18//
19// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25// SOFTWARE.
26
27#pragma once
28
29#include "units/base.h"
30
31namespace units {
32/**
33 * @namespace units::time
34 * @brief namespace for unit types and containers representing time values
35 * @details The SI unit for time is `seconds`, and the corresponding `base_unit`
36 * category is `time_unit`.
37 * @anchor timeContainers
38 * @sa See unit_t for more information on unit type containers.
39 */
40#if !defined(DISABLE_PREDEFINED_UNITS) || defined(ENABLE_PREDEFINED_TIME_UNITS)
41UNIT_ADD_WITH_METRIC_PREFIXES(time, second, seconds, s,
42 unit<std::ratio<1>, units::category::time_unit>)
43UNIT_ADD(time, minute, minutes, min, unit<std::ratio<60>, seconds>)
44UNIT_ADD(time, hour, hours, hr, unit<std::ratio<60>, minutes>)
45UNIT_ADD(time, day, days, d, unit<std::ratio<24>, hours>)
46UNIT_ADD(time, week, weeks, wk, unit<std::ratio<7>, days>)
47UNIT_ADD(time, year, years, yr, unit<std::ratio<365>, days>)
49 unit<std::ratio<31557600>, seconds>)
50UNIT_ADD(time, gregorian_year, gregorian_years, a_g,
51 unit<std::ratio<31556952>, seconds>)
52
54#endif
55
56using namespace time;
57} // namespace units
#define UNIT_ADD_CATEGORY_TRAIT(unitCategory)
Macro to create the is_category_unit type trait.
Definition: base.h:381
constexpr common_t< T1, T2 > min(const T1 x, const T2 y) noexcept
Compile-time pairwise minimum function.
Definition: min.hpp:35
Definition: StdDeque.h:50
Unit Conversion Library namespace.
Definition: current.h:31
UNIT_ADD(area, square_meter, square_meters, sq_m, unit< std::ratio< 1 >, units::category::area_unit >) UNIT_ADD(area
julian_years
Definition: time.h:48
julian_year
Definition: time.h:48
UNIT_ADD_WITH_METRIC_PREFIXES(current, ampere, amperes, A, unit< std::ratio< 1 >, units::category::current_unit >) using namespace current
a_j
Definition: time.h:48
Class representing SI base unit types.
Definition: base.h:758
Type representing an arbitrary unit.
Definition: base.h:884