WPILibC++ 2024.3.2
energy.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::energy
34 * @brief namespace for unit types and containers representing energy values
35 * @details The SI unit for energy is `joules`, and the corresponding
36 * `base_unit` category is `energy_unit`.
37 * @anchor energyContainers
38 * @sa See unit_t for more information on unit type containers.
39 */
40#if !defined(DISABLE_PREDEFINED_UNITS) || \
41 defined(ENABLE_PREDEFINED_ENERGY_UNITS)
42UNIT_ADD_WITH_METRIC_PREFIXES(energy, joule, joules, J,
43 unit<std::ratio<1>, units::category::energy_unit>)
45 unit<std::ratio<4184, 1000>, joules>)
46UNIT_ADD(energy, kilowatt_hour, kilowatt_hours, kWh,
47 unit<std::ratio<36, 10>, megajoules>)
49 unit<std::ratio<1, 1000>, kilowatt_hours>)
50UNIT_ADD(energy, british_thermal_unit, british_thermal_units, BTU,
51 unit<std::ratio<105505585262, 100000000>, joules>)
53 unit<std::ratio<1055056, 1000>, joules>)
54UNIT_ADD(energy, british_thermal_unit_59, british_thermal_units_59, BTU59,
55 unit<std::ratio<1054804, 1000>, joules>)
57 unit<std::ratio<100000>, british_thermal_units_59>)
59 unit<std::ratio<13558179483314004, 10000000000000000>, joules>)
60
62#endif
63
64using namespace energy;
65} // namespace units
#define UNIT_ADD_CATEGORY_TRAIT(unitCategory)
Macro to create the is_category_unit type trait.
Definition: base.h:369
Definition: array.h:89
Unit Conversion Library namespace.
Definition: data.h:31
foot_pounds
Definition: torque.h:47
unit< std::ratio< 4184, 1000 >, joules > unit< std::ratio< 1, 1000 >, kilowatt_hours > british_thermal_units_iso
Definition: energy.h:52
unit< std::ratio< 4184, 1000 >, joules > unit< std::ratio< 1, 1000 >, kilowatt_hours > british_thermal_unit_iso
Definition: energy.h:52
UNIT_ADD_WITH_METRIC_PREFIXES(solid_angle, steradian, steradians, sr, unit< std::ratio< 1 >, units::category::solid_angle_unit >) UNIT_ADD(solid_angle
squared< angle::degrees > UNIT_ADD(solid_angle, spat, spats, sp, unit< std::ratio< 4 >, steradians, std::ratio< 1 > >) using namespace solid_angle
cal
Definition: energy.h:44
unit< std::ratio< 4184, 1000 >, joules > watt_hour
Definition: energy.h:48
unit< std::ratio< 4184, 1000 >, joules > Wh
Definition: energy.h:48
unit< std::ratio< 4184, 1000 >, joules > unit< std::ratio< 1, 1000 >, kilowatt_hours > unit< std::ratio< 1055056, 1000 >, joules > therms
Definition: energy.h:56
unit< std::ratio< 4184, 1000 >, joules > unit< std::ratio< 1, 1000 >, kilowatt_hours > unit< std::ratio< 1055056, 1000 >, joules > thm
Definition: energy.h:56
unit< std::ratio< 4184, 1000 >, joules > watt_hours
Definition: energy.h:48
unit< std::ratio< 4184, 1000 >, joules > unit< std::ratio< 1, 1000 >, kilowatt_hours > BTU_iso
Definition: energy.h:52
calories
Definition: energy.h:44
unit< std::ratio< 4184, 1000 >, joules > unit< std::ratio< 1, 1000 >, kilowatt_hours > unit< std::ratio< 1055056, 1000 >, joules > therm
Definition: energy.h:56
foot_pound
Definition: torque.h:47
calorie
Definition: energy.h:44
Class representing SI base unit types.
Definition: base.h:757
Type representing an arbitrary unit.
Definition: base.h:884