WPILibC++ 2023.4.3
data_transfer_rate.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::data_transfer_rate
34 * @brief namespace for unit types and containers representing data values
35 * @details The base unit for data is `bytes`, and the corresponding `base_unit`
36 * category is `data_unit`.
37 * @anchor dataContainers
38 * @sa See unit_t for more information on unit type containers.
39 */
40#if !defined(DISABLE_PREDEFINED_UNITS) || \
41 defined(ENABLE_PREDEFINED_DATA_TRANSFER_RATE_UNITS)
43 data_transfer_rate, bytes_per_second, bytes_per_second, Bps,
46 unit<std::ratio<1000>, petabytes_per_second>)
48 data_transfer_rate, bits_per_second, bits_per_second, bps,
49 unit<std::ratio<1, 8>, bytes_per_second>)
51 unit<std::ratio<1000>, petabits_per_second>)
52
53UNIT_ADD_CATEGORY_TRAIT(data_transfer_rate)
54#endif
55
56using namespace data_transfer_rate;
57} // namespace units
#define UNIT_ADD_CATEGORY_TRAIT(unitCategory)
Macro to create the is_category_unit type trait.
Definition: base.h:381
Definition: StdDeque.h:50
Unit Conversion Library namespace.
Definition: current.h:31
UNIT_ADD(area, square_meter, square_meters, sq_m, unit< std::ratio< 1 >, units::category::area_unit >) UNIT_ADD(area
exabytes_per_second
Definition: data_transfer_rate.h:45
UNIT_ADD_WITH_METRIC_AND_BINARY_PREFIXES(data_transfer_rate, bytes_per_second, bytes_per_second, Bps, unit< std::ratio< 1 >, units::category::data_transfer_rate_unit >) UNIT_ADD(data_transfer_rate
EBps
Definition: data_transfer_rate.h:45
unit< std::ratio< 1000 >, petabytes_per_second > Ebps
Definition: data_transfer_rate.h:50
unit< std::ratio< 1000 >, petabytes_per_second > exabits_per_second
Definition: data_transfer_rate.h:50
Class representing SI base unit types.
Definition: base.h:758
Type representing an arbitrary unit.
Definition: base.h:884