WPILibC++ 2024.3.2
force.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/acceleration.h"
30#include "units/base.h"
31#include "units/length.h"
32#include "units/mass.h"
33#include "units/time.h"
34
35namespace units {
36/**
37 * @namespace units::force
38 * @brief namespace for unit types and containers representing force values
39 * @details The SI unit for force is `newtons`, and the corresponding
40 * `base_unit` category is `force_unit`.
41 * @anchor forceContainers
42 * @sa See unit_t for more information on unit type containers.
43 */
44#if !defined(DISABLE_PREDEFINED_UNITS) || defined(ENABLE_PREDEFINED_FORCE_UNITS)
45UNIT_ADD_WITH_METRIC_PREFIXES(force, newton, newtons, N,
46 unit<std::ratio<1>, units::category::force_unit>)
48 force, pound, pounds, lbf,
49 compound_unit<mass::slug, length::foot, inverse<squared<time::seconds>>>)
50UNIT_ADD(force, dyne, dynes, dyn, unit<std::ratio<1, 100000>, newtons>)
51UNIT_ADD(force, kilopond, kiloponds, kp,
52 compound_unit<acceleration::standard_gravity, mass::kilograms>)
55 compound_unit<mass::pound, length::foot, inverse<squared<time::seconds>>>)
56
58#endif
59
60using force::newton_t;
61using force::newtons;
62} // namespace units
#define UNIT_ADD_CATEGORY_TRAIT(unitCategory)
Macro to create the is_category_unit type trait.
Definition: base.h:369
typename units::detail::inverse_impl< U >::type inverse
represents the inverse unit type of class U.
Definition: base.h:1134
typename units::detail::squared_impl< U >::type squared
represents the unit type of class U squared
Definition: base.h:1165
typename units::detail::compound_impl< U, Us... >::type compound_unit
Represents a unit type made up from other units.
Definition: base.h:1434
Definition: array.h:89
Unit Conversion Library namespace.
Definition: data.h:31
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
compound_unit< mass::slug, length::foot, inverse< squared< time::seconds > > > pdl
Definition: force.h:54
compound_unit< mass::slug, length::foot, inverse< squared< time::seconds > > > poundal
Definition: force.h:54
lbf
Definition: force.h:48
compound_unit< mass::slug, length::foot, inverse< squared< time::seconds > > > poundals
Definition: force.h:54
pounds
Definition: mass.h:44
pound
Definition: mass.h:44
Class representing SI base unit types.
Definition: base.h:757
Type representing an arbitrary unit.
Definition: base.h:884