WPILibC++ 2024.3.2
area.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
32namespace units {
33/**
34 * @namespace units::area
35 * @brief namespace for unit types and containers representing area values
36 * @details The SI unit for area is `square_meters`, and the corresponding
37 * `base_unit` category is `area_unit`.
38 * @anchor areaContainers
39 * @sa See unit_t for more information on unit type containers.
40 */
41#if !defined(DISABLE_PREDEFINED_UNITS) || defined(ENABLE_PREDEFINED_AREA_UNITS)
42UNIT_ADD(area, square_meter, square_meters, sq_m,
43 unit<std::ratio<1>, units::category::area_unit>)
44UNIT_ADD(area, square_foot, square_feet, sq_ft, squared<length::feet>)
45UNIT_ADD(area, square_inch, square_inches, sq_in, squared<length::inch>)
46UNIT_ADD(area, square_mile, square_miles, sq_mi, squared<length::miles>)
48 squared<length::kilometers>)
49UNIT_ADD(area, hectare, hectares, ha, unit<std::ratio<10000>, square_meters>)
50UNIT_ADD(area, acre, acres, acre, unit<std::ratio<43560>, square_feet>)
51
53#endif
54
55using namespace area;
56} // namespace units
#define UNIT_ADD_CATEGORY_TRAIT(unitCategory)
Macro to create the is_category_unit type trait.
Definition: base.h:369
typename units::detail::squared_impl< U >::type squared
represents the unit type of class U squared
Definition: base.h:1165
Definition: array.h:89
Unit Conversion Library namespace.
Definition: data.h:31
square_kilometer
Definition: area.h:47
square_kilometers
Definition: area.h:47
squared< angle::degrees > UNIT_ADD(solid_angle, spat, spats, sp, unit< std::ratio< 4 >, steradians, std::ratio< 1 > >) using namespace solid_angle
sq_km
Definition: area.h:47
Class representing SI base unit types.
Definition: base.h:757
Type representing an arbitrary unit.
Definition: base.h:884