WPILibC++ 2024.3.2
torque.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#include "units/energy.h"
31#include "units/force.h"
32#include "units/length.h"
33
34namespace units {
35/**
36 * @namespace units::torque
37 * @brief namespace for unit types and containers representing torque values
38 * @details The SI unit for torque is `newton_meters`, and the corresponding
39 * `base_unit` category is `torque_units`.
40 * @anchor torqueContainers
41 * @sa See unit_t for more information on unit type containers.
42 */
43#if !defined(DISABLE_PREDEFINED_UNITS) || \
44 defined(ENABLE_PREDEFINED_TORQUE_UNITS)
45UNIT_ADD(torque, newton_meter, newton_meters, Nm,
46 unit<std::ratio<1>, units::energy::joule>)
48 compound_unit<length::foot, force::pounds>)
49UNIT_ADD(torque, foot_poundal, foot_poundals, ftpdl,
50 compound_unit<length::foot, force::poundal>)
52 compound_unit<length::inch, force::pounds>)
53UNIT_ADD(torque, meter_kilogram, meter_kilograms, mkgf,
54 compound_unit<length::meter, force::kiloponds>)
55
57#endif
58
59using namespace torque;
60} // namespace units
#define UNIT_ADD_CATEGORY_TRAIT(unitCategory)
Macro to create the is_category_unit type trait.
Definition: base.h:369
typename units::detail::compound_impl< U, Us... >::type compound_unit
Represents a unit type made up from other units.
Definition: base.h:1434
Unit Conversion Library namespace.
Definition: data.h:31
foot_pounds
Definition: torque.h:47
squared< angle::degrees > UNIT_ADD(solid_angle, spat, spats, sp, unit< std::ratio< 4 >, steradians, std::ratio< 1 > >) using namespace solid_angle
compound_unit< mass::slug, length::foot, inverse< squared< time::seconds > > > poundal
Definition: force.h:54
compound_unit< length::foot, force::pounds > inlb
Definition: torque.h:51
ftlb
Definition: torque.h:47
compound_unit< length::foot, force::pounds > inch_pounds
Definition: torque.h:51
pounds
Definition: mass.h:44
foot_pound
Definition: torque.h:47
compound_unit< length::foot, force::pounds > inch_pound
Definition: torque.h:51
Type representing an arbitrary unit.
Definition: base.h:884