WPILibC++ 2024.3.2
illuminance.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/luminous_flux.h"
32
33namespace units {
34/**
35 * @namespace units::illuminance
36 * @brief namespace for unit types and containers representing illuminance
37 * values
38 * @details The SI unit for illuminance is `luxes`, and the corresponding
39 * `base_unit` category is `illuminance_unit`.
40 * @anchor illuminanceContainers
41 * @sa See unit_t for more information on unit type containers.
42 */
43#if !defined(DISABLE_PREDEFINED_UNITS) || \
44 defined(ENABLE_PREDEFINED_ILLUMINANCE_UNITS)
46 illuminance, lux, luxes, lx,
49 compound_unit<luminous_flux::lumen, inverse<squared<length::foot>>>)
50UNIT_ADD(illuminance, lumens_per_square_inch, lumens_per_square_inch,
51 lm_per_in_sq,
52 compound_unit<luminous_flux::lumen, inverse<squared<length::inch>>>)
54 illuminance, phot, phots, ph,
55 compound_unit<luminous_flux::lumens, inverse<squared<length::centimeter>>>)
56
57UNIT_ADD_CATEGORY_TRAIT(illuminance)
58#endif
59
60using namespace illuminance;
61} // 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
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< luminous_flux::lumen, inverse< squared< length::foot > > > phots
Definition: illuminance.h:54
fc
Definition: illuminance.h:48
compound_unit< luminous_flux::lumen, inverse< squared< length::foot > > > phot
Definition: illuminance.h:54
footcandle
Definition: illuminance.h:48
footcandles
Definition: illuminance.h:48
compound_unit< luminous_flux::lumen, inverse< squared< length::foot > > > ph
Definition: illuminance.h:54
Class representing SI base unit types.
Definition: base.h:757
Type representing an arbitrary unit.
Definition: base.h:884