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 | Protected Attributes | Private Member Functions | List of all members
PhQ::Frequency< NumericType > Class Template Reference

Frequency. Inverse of a time duration. See also PhQ::Time. More...

#include "Frequency.hpp"

Public Member Functions

 Frequency ()=default
 Default constructor. Constructs a frequency with an uninitialized value. More...
 
 Frequency (const NumericType value, const Unit::Frequency unit)
 Constructor. Constructs a frequency with a given value expressed in a given frequency unit. More...
 
constexpr Frequency (const Time< NumericType > &time)
 Constructor. Constructs a frequency from a given time period using the definition of frequency. More...
 
constexpr Frequency (const ScalarAcceleration< NumericType > &scalar_acceleration, const Speed< NumericType > &speed)
 Constructor. Constructs a frequency from a given scalar acceleration and speed using the definitions of acceleration and frequency. More...
 
constexpr Frequency (const ScalarAngularAcceleration< NumericType > &scalar_angular_acceleration, const AngularSpeed< NumericType > &angular_speed)
 Constructor. Constructs a frequency from a given scalar angular acceleration and angular speed using the definitions of angular acceleration and frequency. More...
 
constexpr Frequency (const AngularSpeed< NumericType > &angular_speed, const Angle< NumericType > &angle)
 Constructor. Constructs a frequency from a given angular speed and angle using the definitions of angular speed and frequency. More...
 
constexpr Frequency (const ElectricCurrent< NumericType > &electric_current, const ElectricCharge< NumericType > &electric_charge)
 Constructor. Constructs a frequency from a given electric current and electric charge using the definitions of electric current and frequency. More...
 
constexpr Frequency (const MassRate< NumericType > &mass_rate, const Mass< NumericType > &mass)
 Constructor. Constructs a frequency from a given mass rate and mass using the definitions of mass rate and frequency. More...
 
constexpr Frequency (const MemoryRate< NumericType > &memory_rate, const Memory< NumericType > &memory)
 Constructor. Constructs a frequency from a given memory rate and memory using the definitions of memory rate and frequency. More...
 
constexpr Frequency (const Power< NumericType > &power, const Energy< NumericType > &energy)
 Constructor. Constructs a frequency from a given power and energy using the definitions of power and frequency. More...
 
constexpr Frequency (const SpecificPower< NumericType > &specific_power, const SpecificEnergy< NumericType > &specific_energy)
 Constructor. Constructs a frequency from a given specific power and specific energy using the definitions of specific power and frequency. More...
 
constexpr Frequency (const Speed< NumericType > &speed, const Length< NumericType > &length)
 Constructor. Constructs a frequency from a given speed and length using the definitions of speed and frequency. More...
 
constexpr Frequency (const VolumeRate< NumericType > &volume_rate, const Volume< NumericType > &volume)
 Constructor. Constructs a frequency from a given volume rate and volume using the definitions of volume rate and frequency. More...
 
 ~Frequency () noexcept=default
 Destructor. Destroys this frequency. More...
 
constexpr Frequency (const Frequency< NumericType > &other)=default
 Copy constructor. Constructs a frequency by copying another one. More...
 
template<typename OtherNumericType >
constexpr Frequency (const Frequency< OtherNumericType > &other)
 Copy constructor. Constructs a frequency by copying another one. More...
 
constexpr Frequency (Frequency< NumericType > &&other) noexcept=default
 Move constructor. Constructs a frequency by moving another one. More...
 
constexpr Frequency< NumericType > & operator= (const Frequency< NumericType > &other)=default
 Copy assignment operator. Assigns this frequency by copying another one. More...
 
template<typename OtherNumericType >
constexpr Frequency< NumericType > & operator= (const Frequency< OtherNumericType > &other)
 Copy assignment operator. Assigns this frequency by copying another one. More...
 
constexpr Frequency< NumericType > & operator= (Frequency< NumericType > &&other) noexcept=default
 Move assignment operator. Assigns this frequency by moving another one. More...
 
constexpr Time< NumericType > Period () const
 Time period that corresponds to this frequency. More...
 
constexpr Frequency< NumericType > operator+ (const Frequency< NumericType > &frequency) const
 
constexpr Frequency< NumericType > operator- (const Frequency< NumericType > &frequency) const
 
constexpr Frequency< NumericType > operator* (const NumericType number) const
 
constexpr Frequency< NumericType > operator/ (const NumericType number) const
 
constexpr NumericType operator* (const Time< NumericType > &time) const noexcept
 
constexpr Speed< NumericType > operator* (const Length< NumericType > &length) const
 
constexpr AngularSpeed< NumericType > operator* (const Angle< NumericType > &angle) const
 
constexpr ElectricCurrent< NumericType > operator* (const ElectricCharge< NumericType > &electric_charge) const
 
constexpr PlanarVelocity< NumericType > operator* (const PlanarDisplacement< NumericType > &displacement) const
 
constexpr Velocity< NumericType > operator* (const Displacement< NumericType > &displacement) const
 
constexpr PlanarAcceleration< NumericType > operator* (const PlanarVelocity< NumericType > &displacement) const
 
constexpr Acceleration< NumericType > operator* (const Velocity< NumericType > &displacement) const
 
constexpr VelocityGradient< NumericType > operator* (const DisplacementGradient< NumericType > &displacement_gradient) const
 
constexpr ScalarVelocityGradient< NumericType > operator* (const ScalarDisplacementGradient< NumericType > &scalar_displacement_gradient) const
 
constexpr MemoryRate< NumericType > operator* (const Memory< NumericType > &memory) const
 
constexpr ScalarAcceleration< NumericType > operator* (const Speed< NumericType > &speed) const
 
constexpr ScalarAngularAcceleration< NumericType > operator* (const AngularSpeed< NumericType > &angular_speed) const
 
constexpr MassRate< NumericType > operator* (const Mass< NumericType > &mass) const
 
constexpr VolumeRate< NumericType > operator* (const Volume< NumericType > &volume) const
 
constexpr Power< NumericType > operator* (const Energy< NumericType > &energy) const
 
constexpr SpecificPower< NumericType > operator* (const SpecificEnergy< NumericType > &specific_energy) const
 
constexpr StrainRate< NumericType > operator* (const Strain< NumericType > &strain) const
 
constexpr ScalarStrainRate< NumericType > operator* (const ScalarStrain< NumericType > &scalar_strain) const
 
constexpr NumericType operator/ (const Frequency< NumericType > &frequency) const noexcept
 
constexpr void operator+= (const Frequency< NumericType > &frequency) noexcept
 
constexpr void operator-= (const Frequency< NumericType > &frequency) noexcept
 
constexpr void operator*= (const NumericType number) noexcept
 
constexpr void operator/= (const NumericType number) noexcept
 
constexpr double Value () const noexcept
 Value of this physical quantity expressed in its standard unit of measure. More...
 
double Value (const Unit::Frequency unit) const
 Value of this physical quantity expressed in a given unit of measure. More...
 
constexpr double StaticValue () const
 Value of this physical quantity expressed in a given unit of measure. This method can be evaluated statically at compile-time. More...
 
constexpr double & MutableValue () noexcept
 Returns the value of this physical quantity expressed in its standard unit of measure as a mutable value. More...
 
constexpr void SetValue (const double value) noexcept
 Sets the value of this physical quantity expressed in its standard unit of measure to the given value. More...
 
std::string Print () const
 Prints this physical quantity as a string. This physical quantity's value is expressed in its standard unit of measure. More...
 
std::string Print (const Unit::Frequency unit) const
 Prints this physical quantity as a string. This physical quantity's value is expressed in the given unit of measure. More...
 
std::string JSON () const
 Serializes this physical quantity as a JSON message. This physical quantity's value is expressed in its standard unit of measure. More...
 
std::string JSON (const Unit::Frequency unit) const
 Serializes this physical quantity as a JSON message. This physical quantity's value is expressed in the given unit of measure. More...
 
std::string XML () const
 Serializes this physical quantity as an XML message. This physical quantity's value is expressed in its standard unit of measure. More...
 
std::string XML (const Unit::Frequency unit) const
 Serializes this physical quantity as an XML message. This physical quantity's value is expressed in the given unit of measure. More...
 
std::string YAML () const
 Serializes this physical quantity as a YAML message. This physical quantity's value is expressed in its standard unit of measure. More...
 
std::string YAML (const Unit::Frequency unit) const
 Serializes this physical quantity as a YAML message. This physical quantity's value is expressed in the given unit of measure. More...
 

Static Public Member Functions

static constexpr Frequency< NumericType > Zero ()
 Statically creates a frequency of zero. More...
 
template<Unit::Frequency Unit>
static constexpr Frequency< NumericType > Create (const NumericType value)
 Statically creates a frequency with a given value expressed in a given frequency unit. More...
 
static constexpr const PhQ::Dimensions & Dimensions ()
 Physical dimension set of this physical quantity. More...
 
static constexpr Unit::Frequency Unit ()
 Standard unit of measure for this physical quantity. This physical quantity's value is stored internally in this unit of measure. More...
 

Protected Attributes

double value
 Value of this physical quantity expressed in its standard unit of measure. More...
 

Private Member Functions

constexpr Frequency (const NumericType value)
 Constructor. Constructs a frequency with a given value expressed in the standard frequency unit. More...
 

Detailed Description

template<typename NumericType = double>
class PhQ::Frequency< NumericType >

Frequency. Inverse of a time duration. See also PhQ::Time.

Definition at line 40 of file Frequency.hpp.

Constructor & Destructor Documentation

◆ Frequency() [1/17]

template<typename NumericType = double>
PhQ::Frequency< NumericType >::Frequency ( )
default

Default constructor. Constructs a frequency with an uninitialized value.

◆ Frequency() [2/17]

template<typename NumericType = double>
PhQ::Frequency< NumericType >::Frequency ( const NumericType  value,
const Unit::Frequency< NumericType >  unit 
)
inline

Constructor. Constructs a frequency with a given value expressed in a given frequency unit.

Definition at line 47 of file Frequency.hpp.

◆ Frequency() [3/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( const Time< NumericType > &  time)
inlineexplicitconstexpr

Constructor. Constructs a frequency from a given time period using the definition of frequency.

Definition at line 52 of file Frequency.hpp.

◆ Frequency() [4/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( const ScalarAcceleration< NumericType > &  scalar_acceleration,
const Speed< NumericType > &  speed 
)
constexpr

Constructor. Constructs a frequency from a given scalar acceleration and speed using the definitions of acceleration and frequency.

◆ Frequency() [5/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( const ScalarAngularAcceleration< NumericType > &  scalar_angular_acceleration,
const AngularSpeed< NumericType > &  angular_speed 
)
constexpr

Constructor. Constructs a frequency from a given scalar angular acceleration and angular speed using the definitions of angular acceleration and frequency.

◆ Frequency() [6/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( const AngularSpeed< NumericType > &  angular_speed,
const Angle< NumericType > &  angle 
)
constexpr

Constructor. Constructs a frequency from a given angular speed and angle using the definitions of angular speed and frequency.

◆ Frequency() [7/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( const ElectricCurrent< NumericType > &  electric_current,
const ElectricCharge< NumericType > &  electric_charge 
)
constexpr

Constructor. Constructs a frequency from a given electric current and electric charge using the definitions of electric current and frequency.

◆ Frequency() [8/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( const MassRate< NumericType > &  mass_rate,
const Mass< NumericType > &  mass 
)
constexpr

Constructor. Constructs a frequency from a given mass rate and mass using the definitions of mass rate and frequency.

◆ Frequency() [9/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( const MemoryRate< NumericType > &  memory_rate,
const Memory< NumericType > &  memory 
)
constexpr

Constructor. Constructs a frequency from a given memory rate and memory using the definitions of memory rate and frequency.

◆ Frequency() [10/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( const Power< NumericType > &  power,
const Energy< NumericType > &  energy 
)
constexpr

Constructor. Constructs a frequency from a given power and energy using the definitions of power and frequency.

◆ Frequency() [11/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( const SpecificPower< NumericType > &  specific_power,
const SpecificEnergy< NumericType > &  specific_energy 
)
constexpr

Constructor. Constructs a frequency from a given specific power and specific energy using the definitions of specific power and frequency.

◆ Frequency() [12/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( const Speed< NumericType > &  speed,
const Length< NumericType > &  length 
)
constexpr

Constructor. Constructs a frequency from a given speed and length using the definitions of speed and frequency.

◆ Frequency() [13/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( const VolumeRate< NumericType > &  volume_rate,
const Volume< NumericType > &  volume 
)
constexpr

Constructor. Constructs a frequency from a given volume rate and volume using the definitions of volume rate and frequency.

◆ ~Frequency()

template<typename NumericType = double>
PhQ::Frequency< NumericType >::~Frequency ( )
defaultnoexcept

Destructor. Destroys this frequency.

◆ Frequency() [14/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( const Frequency< NumericType > &  other)
constexprdefault

Copy constructor. Constructs a frequency by copying another one.

◆ Frequency() [15/17]

template<typename NumericType = double>
template<typename OtherNumericType >
constexpr PhQ::Frequency< NumericType >::Frequency ( const Frequency< OtherNumericType > &  other)
inlineexplicitconstexpr

Copy constructor. Constructs a frequency by copying another one.

Definition at line 110 of file Frequency.hpp.

◆ Frequency() [16/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( Frequency< NumericType > &&  other)
constexprdefaultnoexcept

Move constructor. Constructs a frequency by moving another one.

◆ Frequency() [17/17]

template<typename NumericType = double>
constexpr PhQ::Frequency< NumericType >::Frequency ( const NumericType  value)
inlineexplicitconstexprprivate

Constructor. Constructs a frequency with a given value expressed in the standard frequency unit.

Definition at line 233 of file Frequency.hpp.

Member Function Documentation

◆ Create()

template<typename NumericType = double>
template<Unit::Frequency Unit>
static constexpr Frequency<NumericType> PhQ::Frequency< NumericType >::Create ( const NumericType  value)
inlinestaticconstexpr

Statically creates a frequency with a given value expressed in a given frequency unit.

Definition at line 136 of file Frequency.hpp.

References PhQ::DimensionalScalar< Unit::Frequency, double >::value.

◆ Dimensions()

static constexpr const PhQ::Dimensions& PhQ::DimensionalScalar< Unit::Frequency , double >::Dimensions ( )
inlinestaticconstexprinherited

Physical dimension set of this physical quantity.

Definition at line 54 of file DimensionalScalar.hpp.

◆ JSON() [1/2]

std::string PhQ::DimensionalScalar< Unit::Frequency , double >::JSON ( ) const
inlineinherited

Serializes this physical quantity as a JSON message. This physical quantity's value is expressed in its standard unit of measure.

Definition at line 107 of file DimensionalScalar.hpp.

◆ JSON() [2/2]

std::string PhQ::DimensionalScalar< Unit::Frequency , double >::JSON ( const Unit::Frequency  unit) const
inlineinherited

Serializes this physical quantity as a JSON message. This physical quantity's value is expressed in the given unit of measure.

Definition at line 117 of file DimensionalScalar.hpp.

◆ MutableValue()

constexpr double & PhQ::DimensionalScalar< Unit::Frequency , double >::MutableValue ( )
inlineconstexprnoexceptinherited

Returns the value of this physical quantity expressed in its standard unit of measure as a mutable value.

Definition at line 83 of file DimensionalScalar.hpp.

◆ operator*() [1/20]

template<typename NumericType = double>
constexpr AngularSpeed<NumericType> PhQ::Frequency< NumericType >::operator* ( const Angle< NumericType > &  angle) const
constexpr

◆ operator*() [2/20]

template<typename NumericType = double>
constexpr ScalarAngularAcceleration<NumericType> PhQ::Frequency< NumericType >::operator* ( const AngularSpeed< NumericType > &  angular_speed) const
constexpr

◆ operator*() [3/20]

template<typename NumericType = double>
constexpr Velocity<NumericType> PhQ::Frequency< NumericType >::operator* ( const Displacement< NumericType > &  displacement) const
constexpr

◆ operator*() [4/20]

template<typename NumericType = double>
constexpr VelocityGradient<NumericType> PhQ::Frequency< NumericType >::operator* ( const DisplacementGradient< NumericType > &  displacement_gradient) const
constexpr

◆ operator*() [5/20]

template<typename NumericType = double>
constexpr ElectricCurrent<NumericType> PhQ::Frequency< NumericType >::operator* ( const ElectricCharge< NumericType > &  electric_charge) const
constexpr

◆ operator*() [6/20]

template<typename NumericType = double>
constexpr Power<NumericType> PhQ::Frequency< NumericType >::operator* ( const Energy< NumericType > &  energy) const
constexpr

◆ operator*() [7/20]

template<typename NumericType = double>
constexpr Speed<NumericType> PhQ::Frequency< NumericType >::operator* ( const Length< NumericType > &  length) const
constexpr

◆ operator*() [8/20]

template<typename NumericType = double>
constexpr MassRate<NumericType> PhQ::Frequency< NumericType >::operator* ( const Mass< NumericType > &  mass) const
constexpr

◆ operator*() [9/20]

template<typename NumericType = double>
constexpr MemoryRate<NumericType> PhQ::Frequency< NumericType >::operator* ( const Memory< NumericType > &  memory) const
constexpr

◆ operator*() [10/20]

template<typename NumericType = double>
constexpr Frequency<NumericType> PhQ::Frequency< NumericType >::operator* ( const NumericType  number) const
inlineconstexpr

Definition at line 154 of file Frequency.hpp.

References PhQ::DimensionalScalar< Unit::Frequency, double >::value.

◆ operator*() [11/20]

template<typename NumericType = double>
constexpr PlanarVelocity<NumericType> PhQ::Frequency< NumericType >::operator* ( const PlanarDisplacement< NumericType > &  displacement) const
constexpr

◆ operator*() [12/20]

template<typename NumericType = double>
constexpr PlanarAcceleration<NumericType> PhQ::Frequency< NumericType >::operator* ( const PlanarVelocity< NumericType > &  displacement) const
constexpr

◆ operator*() [13/20]

template<typename NumericType = double>
constexpr ScalarVelocityGradient<NumericType> PhQ::Frequency< NumericType >::operator* ( const ScalarDisplacementGradient< NumericType > &  scalar_displacement_gradient) const
constexpr

◆ operator*() [14/20]

template<typename NumericType = double>
constexpr ScalarStrainRate<NumericType> PhQ::Frequency< NumericType >::operator* ( const ScalarStrain< NumericType > &  scalar_strain) const
constexpr

◆ operator*() [15/20]

template<typename NumericType = double>
constexpr SpecificPower<NumericType> PhQ::Frequency< NumericType >::operator* ( const SpecificEnergy< NumericType > &  specific_energy) const
constexpr

◆ operator*() [16/20]

template<typename NumericType = double>
constexpr ScalarAcceleration<NumericType> PhQ::Frequency< NumericType >::operator* ( const Speed< NumericType > &  speed) const
constexpr

◆ operator*() [17/20]

template<typename NumericType = double>
constexpr StrainRate<NumericType> PhQ::Frequency< NumericType >::operator* ( const Strain< NumericType > &  strain) const
constexpr

◆ operator*() [18/20]

template<typename NumericType = double>
constexpr NumericType PhQ::Frequency< NumericType >::operator* ( const Time< NumericType > &  time) const
inlineconstexprnoexcept

Definition at line 162 of file Frequency.hpp.

References PhQ::DimensionalScalar< Unit::Frequency, double >::value.

◆ operator*() [19/20]

template<typename NumericType = double>
constexpr Acceleration<NumericType> PhQ::Frequency< NumericType >::operator* ( const Velocity< NumericType > &  displacement) const
constexpr

◆ operator*() [20/20]

template<typename NumericType = double>
constexpr VolumeRate<NumericType> PhQ::Frequency< NumericType >::operator* ( const Volume< NumericType > &  volume) const
constexpr

◆ operator*=()

template<typename NumericType = double>
constexpr void PhQ::Frequency< NumericType >::operator*= ( const NumericType  number)
inlineconstexprnoexcept

Definition at line 222 of file Frequency.hpp.

References PhQ::DimensionalScalar< Unit::Frequency, double >::value.

◆ operator+()

template<typename NumericType = double>
constexpr Frequency<NumericType> PhQ::Frequency< NumericType >::operator+ ( const Frequency< NumericType > &  frequency) const
inlineconstexpr

Definition at line 146 of file Frequency.hpp.

References PhQ::DimensionalScalar< UnitType, NumericType >::value, and PhQ::DimensionalScalar< Unit::Frequency, double >::value.

◆ operator+=()

template<typename NumericType = double>
constexpr void PhQ::Frequency< NumericType >::operator+= ( const Frequency< NumericType > &  frequency)
inlineconstexprnoexcept

Definition at line 214 of file Frequency.hpp.

References PhQ::DimensionalScalar< Unit::Frequency, double >::value.

◆ operator-()

template<typename NumericType = double>
constexpr Frequency<NumericType> PhQ::Frequency< NumericType >::operator- ( const Frequency< NumericType > &  frequency) const
inlineconstexpr

Definition at line 150 of file Frequency.hpp.

References PhQ::DimensionalScalar< UnitType, NumericType >::value, and PhQ::DimensionalScalar< Unit::Frequency, double >::value.

◆ operator-=()

template<typename NumericType = double>
constexpr void PhQ::Frequency< NumericType >::operator-= ( const Frequency< NumericType > &  frequency)
inlineconstexprnoexcept

Definition at line 218 of file Frequency.hpp.

References PhQ::DimensionalScalar< Unit::Frequency, double >::value.

◆ operator/() [1/2]

template<typename NumericType = double>
constexpr NumericType PhQ::Frequency< NumericType >::operator/ ( const Frequency< NumericType > &  frequency) const
inlineconstexprnoexcept

Definition at line 210 of file Frequency.hpp.

References PhQ::DimensionalScalar< Unit::Frequency, double >::value.

◆ operator/() [2/2]

template<typename NumericType = double>
constexpr Frequency<NumericType> PhQ::Frequency< NumericType >::operator/ ( const NumericType  number) const
inlineconstexpr

Definition at line 158 of file Frequency.hpp.

References PhQ::DimensionalScalar< Unit::Frequency, double >::value.

◆ operator/=()

template<typename NumericType = double>
constexpr void PhQ::Frequency< NumericType >::operator/= ( const NumericType  number)
inlineconstexprnoexcept

Definition at line 226 of file Frequency.hpp.

References PhQ::DimensionalScalar< Unit::Frequency, double >::value.

◆ operator=() [1/3]

template<typename NumericType = double>
constexpr Frequency<NumericType>& PhQ::Frequency< NumericType >::operator= ( const Frequency< NumericType > &  other)
constexprdefault

Copy assignment operator. Assigns this frequency by copying another one.

◆ operator=() [2/3]

template<typename NumericType = double>
template<typename OtherNumericType >
constexpr Frequency<NumericType>& PhQ::Frequency< NumericType >::operator= ( const Frequency< OtherNumericType > &  other)
inlineconstexpr

Copy assignment operator. Assigns this frequency by copying another one.

Definition at line 121 of file Frequency.hpp.

References PhQ::DimensionalScalar< UnitType, NumericType >::Value(), and PhQ::DimensionalScalar< Unit::Frequency, double >::value.

◆ operator=() [3/3]

template<typename NumericType = double>
constexpr Frequency<NumericType>& PhQ::Frequency< NumericType >::operator= ( Frequency< NumericType > &&  other)
constexprdefaultnoexcept

Move assignment operator. Assigns this frequency by moving another one.

◆ Period()

template<typename NumericType = double>
constexpr Time<NumericType> PhQ::Frequency< NumericType >::Period ( ) const
inlineconstexpr

Time period that corresponds to this frequency.

Definition at line 142 of file Frequency.hpp.

◆ Print() [1/2]

std::string PhQ::DimensionalScalar< Unit::Frequency , double >::Print ( ) const
inlineinherited

Prints this physical quantity as a string. This physical quantity's value is expressed in its standard unit of measure.

Definition at line 95 of file DimensionalScalar.hpp.

◆ Print() [2/2]

std::string PhQ::DimensionalScalar< Unit::Frequency , double >::Print ( const Unit::Frequency  unit) const
inlineinherited

Prints this physical quantity as a string. This physical quantity's value is expressed in the given unit of measure.

Definition at line 101 of file DimensionalScalar.hpp.

◆ SetValue()

constexpr void PhQ::DimensionalScalar< Unit::Frequency , double >::SetValue ( const double  value)
inlineconstexprnoexceptinherited

Sets the value of this physical quantity expressed in its standard unit of measure to the given value.

Definition at line 89 of file DimensionalScalar.hpp.

◆ StaticValue()

constexpr double PhQ::DimensionalScalar< Unit::Frequency , double >::StaticValue ( ) const
inlineconstexprinherited

Value of this physical quantity expressed in a given unit of measure. This method can be evaluated statically at compile-time.

Definition at line 77 of file DimensionalScalar.hpp.

◆ Unit()

static constexpr Unit::Frequency PhQ::DimensionalScalar< Unit::Frequency , double >::Unit ( )
inlinestaticconstexprinherited

Standard unit of measure for this physical quantity. This physical quantity's value is stored internally in this unit of measure.

Definition at line 60 of file DimensionalScalar.hpp.

◆ Value() [1/2]

constexpr double PhQ::DimensionalScalar< Unit::Frequency , double >::Value ( ) const
inlineconstexprnoexceptinherited

Value of this physical quantity expressed in its standard unit of measure.

Definition at line 65 of file DimensionalScalar.hpp.

◆ Value() [2/2]

double PhQ::DimensionalScalar< Unit::Frequency , double >::Value ( const Unit::Frequency  unit) const
inlineinherited

Value of this physical quantity expressed in a given unit of measure.

Definition at line 70 of file DimensionalScalar.hpp.

◆ XML() [1/2]

std::string PhQ::DimensionalScalar< Unit::Frequency , double >::XML ( ) const
inlineinherited

Serializes this physical quantity as an XML message. This physical quantity's value is expressed in its standard unit of measure.

Definition at line 127 of file DimensionalScalar.hpp.

◆ XML() [2/2]

std::string PhQ::DimensionalScalar< Unit::Frequency , double >::XML ( const Unit::Frequency  unit) const
inlineinherited

Serializes this physical quantity as an XML message. This physical quantity's value is expressed in the given unit of measure.

Definition at line 137 of file DimensionalScalar.hpp.

◆ YAML() [1/2]

std::string PhQ::DimensionalScalar< Unit::Frequency , double >::YAML ( ) const
inlineinherited

Serializes this physical quantity as a YAML message. This physical quantity's value is expressed in its standard unit of measure.

Definition at line 147 of file DimensionalScalar.hpp.

◆ YAML() [2/2]

std::string PhQ::DimensionalScalar< Unit::Frequency , double >::YAML ( const Unit::Frequency  unit) const
inlineinherited

Serializes this physical quantity as a YAML message. This physical quantity's value is expressed in the given unit of measure.

Definition at line 157 of file DimensionalScalar.hpp.

◆ Zero()

template<typename NumericType = double>
static constexpr Frequency<NumericType> PhQ::Frequency< NumericType >::Zero ( )
inlinestaticconstexpr

Statically creates a frequency of zero.

Definition at line 130 of file Frequency.hpp.

Member Data Documentation

◆ value

double PhQ::DimensionalScalar< Unit::Frequency , double >::value
protectedinherited

Value of this physical quantity expressed in its standard unit of measure.

Definition at line 221 of file DimensionalScalar.hpp.

The documentation for this class was generated from the following files:
Physical Quantities (PhQ): Git Repository | Documentation