Physical Quantities  v1.0.0
C++ library of physical quantities, physical models, and units of measure for scientific computing. https://github.com/acodcha/phq
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
PhQ::Dimension::ElectricCurrent Class Reference

Base physical dimension of electric current. Typically denoted "I". One of seven independent base physical dimensions that form the physical dimension set of any unit of measure or physical quantity. Part of PhQ::Dimensions. More...

#include "ElectricCurrent.hpp"

Public Member Functions

constexpr ElectricCurrent ()=default
 Default constructor. Constructs a base physical dimension of electric current with a value of zero. More...
 
constexpr ElectricCurrent (const int8_t value)
 Constructor. Constructs a base physical dimension of electric current with a given value. More...
 
 ~ElectricCurrent () noexcept=default
 Destructor. Destroys this base physical dimension of electric current. More...
 
constexpr ElectricCurrent (const ElectricCurrent &other)=default
 Copy constructor. Constructs a base physical dimension of electric current by copying another one. More...
 
constexpr ElectricCurrentoperator= (const ElectricCurrent &other)=default
 Copy assignment operator. Assigns the value of this base physical dimension of electric current by copying from another one. More...
 
constexpr ElectricCurrent (ElectricCurrent &&other) noexcept=default
 Move constructor. Constructs a base physical dimension of electric current by moving another one. More...
 
constexpr ElectricCurrentoperator= (ElectricCurrent &&other) noexcept=default
 Move assignment operator. Assigns the value of this base physical dimension of electric current by moving another one. More...
 
constexpr int8_t Value () const noexcept
 Value of this base physical dimension. More...
 
std::string Print () const noexcept
 Prints this base physical dimension as a string. More...
 

Static Public Member Functions

static std::string_view Abbreviation () noexcept
 Abbreviation of this base physical dimension. More...
 
static std::string_view Label () noexcept
 Label of this base physical dimension. More...
 

Private Attributes

int8_t value {0}
 Value of this base physical dimension. More...
 

Detailed Description

Base physical dimension of electric current. Typically denoted "I". One of seven independent base physical dimensions that form the physical dimension set of any unit of measure or physical quantity. Part of PhQ::Dimensions.

Definition at line 40 of file ElectricCurrent.hpp.

Constructor & Destructor Documentation

◆ ElectricCurrent() [1/4]

constexpr PhQ::Dimension::ElectricCurrent::ElectricCurrent ( )
constexprdefault

Default constructor. Constructs a base physical dimension of electric current with a value of zero.

◆ ElectricCurrent() [2/4]

constexpr PhQ::Dimension::ElectricCurrent::ElectricCurrent ( const int8_t  value)
inlineexplicitconstexpr

Constructor. Constructs a base physical dimension of electric current with a given value.

Definition at line 48 of file ElectricCurrent.hpp.

◆ ~ElectricCurrent()

PhQ::Dimension::ElectricCurrent::~ElectricCurrent ( )
defaultnoexcept

Destructor. Destroys this base physical dimension of electric current.

◆ ElectricCurrent() [3/4]

constexpr PhQ::Dimension::ElectricCurrent::ElectricCurrent ( const ElectricCurrent other)
constexprdefault

Copy constructor. Constructs a base physical dimension of electric current by copying another one.

◆ ElectricCurrent() [4/4]

constexpr PhQ::Dimension::ElectricCurrent::ElectricCurrent ( ElectricCurrent &&  other)
constexprdefaultnoexcept

Move constructor. Constructs a base physical dimension of electric current by moving another one.

Member Function Documentation

◆ Abbreviation()

static std::string_view PhQ::Dimension::ElectricCurrent::Abbreviation ( )
inlinestaticnoexcept

Abbreviation of this base physical dimension.

Definition at line 75 of file ElectricCurrent.hpp.

Referenced by Print().

◆ Label()

static std::string_view PhQ::Dimension::ElectricCurrent::Label ( )
inlinestaticnoexcept

Label of this base physical dimension.

Definition at line 80 of file ElectricCurrent.hpp.

Referenced by PhQ::Dimensions::JSON(), PhQ::Dimensions::XML(), and PhQ::Dimensions::YAML().

◆ operator=() [1/2]

constexpr ElectricCurrent& PhQ::Dimension::ElectricCurrent::operator= ( const ElectricCurrent other)
constexprdefault

Copy assignment operator. Assigns the value of this base physical dimension of electric current by copying from another one.

◆ operator=() [2/2]

constexpr ElectricCurrent& PhQ::Dimension::ElectricCurrent::operator= ( ElectricCurrent &&  other)
constexprdefaultnoexcept

Move assignment operator. Assigns the value of this base physical dimension of electric current by moving another one.

◆ Print()

std::string PhQ::Dimension::ElectricCurrent::Print ( ) const
inlinenoexcept

Prints this base physical dimension as a string.

Definition at line 85 of file ElectricCurrent.hpp.

References Abbreviation(), and value.

Referenced by PhQ::Dimension::operator<<(), and PhQ::Dimensions::Print().

◆ Value()

constexpr int8_t PhQ::Dimension::ElectricCurrent::Value ( ) const
inlineconstexprnoexcept

Value of this base physical dimension.

Definition at line 70 of file ElectricCurrent.hpp.

References value.

Referenced by PhQ::Dimensions::JSON(), PhQ::Dimensions::XML(), and PhQ::Dimensions::YAML().

Member Data Documentation

◆ value

int8_t PhQ::Dimension::ElectricCurrent::value {0}
private

Value of this base physical dimension.

Definition at line 100 of file ElectricCurrent.hpp.

Referenced by Print(), and Value().


The documentation for this class was generated from the following file: