WPILibC++ 2024.1.1-beta-4
acceleration.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/length.h"
31#include "units/time.h"
32
33namespace units {
34/**
35 * @namespace units::acceleration
36 * @brief namespace for unit types and containers representing acceleration
37 * values
38 * @details The SI unit for acceleration is `meters_per_second_squared`, and the
39 * corresponding `base_unit` category is `acceleration_unit`.
40 * @anchor accelerationContainers
41 * @sa See unit_t for more information on unit type containers.
42 */
43#if !defined(DISABLE_PREDEFINED_UNITS) || \
44 defined(ENABLE_PREDEFINED_ACCELERATION_UNITS)
45UNIT_ADD(acceleration, meters_per_second_squared, meters_per_second_squared,
46 mps_sq, unit<std::ratio<1>, units::category::acceleration_unit>)
48 compound_unit<length::feet, inverse<squared<time::seconds>>>)
49UNIT_ADD(acceleration, standard_gravity, standard_gravity, SG,
50 unit<std::ratio<980665, 100000>, meters_per_second_squared>)
51
52UNIT_ADD_CATEGORY_TRAIT(acceleration)
53#endif
54
55using namespace acceleration;
56} // namespace units
#define UNIT_ADD_CATEGORY_TRAIT(unitCategory)
Macro to create the is_category_unit type trait.
Definition: base.h:381
typename units::detail::inverse_impl< U >::type inverse
represents the inverse unit type of class U.
Definition: base.h:1146
typename units::detail::squared_impl< U >::type squared
represents the unit type of class U squared
Definition: base.h:1177
typename units::detail::compound_impl< U, Us... >::type compound_unit
Represents a unit type made up from other units.
Definition: base.h:1446
Definition: array.h:89
Unit Conversion Library namespace.
Definition: angle.h:31
feet_per_second_squared
Definition: acceleration.h:47
fps_sq
Definition: acceleration.h:47
unit< std::ratio< 1, 180 >, radians, std::ratio< 1 > > UNIT_ADD(angle, arcsecond, arcseconds, arcsec, unit< std::ratio< 1, 60 >, arcminutes >) using namespace angle
Class representing SI base unit types.
Definition: base.h:769
Type representing an arbitrary unit.
Definition: base.h:896