WPILibC++ 2024.3.2
concentration.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::concentration
34 * @brief namespace for unit types and containers representing concentration
35 * values
36 * @details The SI unit for concentration is `parts_per_million`, and the
37 * corresponding `base_unit` category is `scalar_unit`.
38 * @anchor concentrationContainers
39 * @sa See unit_t for more information on unit type containers.
40 */
41#if !defined(DISABLE_PREDEFINED_UNITS) || \
42 defined(ENABLE_PREDEFINED_CONCENTRATION_UNITS)
43UNIT_ADD(concentration, ppm, parts_per_million, ppm,
44 unit<std::ratio<1, 1000000>, units::category::scalar_unit>)
46 unit<std::ratio<1, 1000>, parts_per_million>)
47UNIT_ADD(concentration, ppt, parts_per_trillion, ppt,
48 unit<std::ratio<1, 1000>, parts_per_billion>)
49UNIT_ADD(concentration, percent, percent, pct,
50 unit<std::ratio<1, 100>, units::category::scalar_unit>)
51
52UNIT_ADD_CATEGORY_TRAIT(concentration)
53#endif
54
55using namespace concentration;
56} // 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
base_unit scalar_unit
Represents a quantity with no dimension.
Definition: base.h:790
Unit Conversion Library namespace.
Definition: data.h:31
unit< std::ratio< 1, 1000 >, parts_per_million > percent
Definition: concentration.h:49
squared< angle::degrees > UNIT_ADD(solid_angle, spat, spats, sp, unit< std::ratio< 4 >, steradians, std::ratio< 1 > >) using namespace solid_angle
ppb
Definition: concentration.h:45
unit< std::ratio< 1, 1000 >, parts_per_million > pct
Definition: concentration.h:49
parts_per_billion
Definition: concentration.h:45
Class representing SI base unit types.
Definition: base.h:757
Type representing an arbitrary unit.
Definition: base.h:884