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::Angle< NumericType > Class Template Reference

Plane angle between two lines or dihedral angle between two planes. More...

#include "Angle.hpp"

Public Member Functions

 Angle ()=default
 Default constructor. Constructs an angle with an uninitialized value. More...
 
 Angle (const NumericType value, const Unit::Angle unit)
 Constructor. Constructs an angle with a given value expressed in a given angle unit. More...
 
 Angle (const PlanarVector< NumericType > &planar_vector_1, const PlanarVector< NumericType > &planar_vector_2)
 Constructor. Constructs an angle by computing the angle between two given planar vectors. More...
 
 Angle (const Vector< NumericType > &vector1, const Vector< NumericType > &vector2)
 Constructor. Constructs an angle by computing the angle between two given vectors. More...
 
 Angle (const PlanarVector< NumericType > &planar_vector, const PlanarDirection< NumericType > &planar_direction)
 Constructor. Constructs an angle by computing the angle between a given planar vector and planar direction. More...
 
 Angle (const Vector< NumericType > &vector, const Direction< NumericType > &direction)
 Constructor. Constructs an angle by computing the angle between a given vector and direction. More...
 
 Angle (const PlanarDirection< NumericType > &planar_direction, const PlanarVector< NumericType > &planar_vector)
 Constructor. Constructs an angle by computing the angle between a given planar direction and planar vector. More...
 
 Angle (const Direction< NumericType > &direction, const Vector< NumericType > &vector)
 Constructor. Constructs an angle by computing the angle between a given direction and vector. More...
 
 Angle (const PlanarDirection< NumericType > &planar_direction_1, const PlanarDirection< NumericType > &planar_direction_2)
 Constructor. Constructs an angle by computing the angle between two given planar directions. More...
 
 Angle (const Direction< NumericType > &direction1, const Direction< NumericType > &direction2)
 Constructor. Constructs an angle by computing the angle between two given directions. More...
 
constexpr Angle (const AngularSpeed< NumericType > &angular_speed, const Time< NumericType > &time)
 Constructor. Constructs an angle from a given angular speed and time using the definition of angular speed. More...
 
constexpr Angle (const AngularSpeed< NumericType > &angular_speed, const Frequency< NumericType > &frequency)
 Constructor. Constructs an angle from a given angular speed and frequency using the definition of angular speed. More...
 
 Angle (const Acceleration< NumericType > &acceleration1, const Acceleration< NumericType > &acceleration2)
 Constructor. Constructs an angle by computing the angle between two given acceleration vectors. More...
 
 Angle (const VectorArea< NumericType > &vector_area_1, const VectorArea< NumericType > &vector_area_2)
 Constructor. Constructs an angle by computing the angle between two given vector areas. More...
 
 Angle (const Displacement< NumericType > &displacement1, const Displacement< NumericType > &displacement2)
 Constructor. Constructs an angle by computing the angle between two given displacements. More...
 
 Angle (const Force< NumericType > &force1, const Force< NumericType > &force2)
 Constructor. Constructs an angle by computing the angle between two given forces. More...
 
 Angle (const HeatFlux< NumericType > &heat_flux_1, const HeatFlux< NumericType > &heat_flux_2)
 Constructor. Constructs an angle by computing the angle between two given heat fluxes. More...
 
 Angle (const PlanarAcceleration< NumericType > &planar_acceleration_1, const PlanarAcceleration< NumericType > &planar_acceleration_2)
 Constructor. Constructs an angle by computing the angle between two given planar acceleration vectors. More...
 
 Angle (const PlanarDisplacement< NumericType > &planar_displacement_1, const PlanarDisplacement< NumericType > &planar_displacement_2)
 Constructor. Constructs an angle by computing the angle between two given planar displacements. More...
 
 Angle (const PlanarForce< NumericType > &planar_force_1, const PlanarForce< NumericType > &planar_force_2)
 Constructor. Constructs an angle by computing the angle between two given planar forces. More...
 
 Angle (const PlanarHeatFlux< NumericType > &planar_heat_flux_1, const PlanarHeatFlux< NumericType > &planar_heat_flux_2)
 Constructor. Constructs an angle by computing the angle between two given planar heat fluxes. More...
 
 Angle (const PlanarPosition< NumericType > &planar_position_1, const PlanarPosition< NumericType > &planar_position_2)
 Constructor. Constructs an angle by computing the angle between two given planar positions. More...
 
 Angle (const PlanarTemperatureGradient< NumericType > &planar_temperature_gradient_1, const PlanarTemperatureGradient< NumericType > &planar_temperature_gradient_2)
 Constructor. Constructs an angle by computing the angle between two given planar temperature gradients. More...
 
 Angle (const PlanarTraction< NumericType > &planar_traction_1, const PlanarTraction< NumericType > &planar_traction_2)
 Constructor. Constructs an angle by computing the angle between two given planar tractions. More...
 
 Angle (const PlanarVelocity< NumericType > &planar_velocity_1, const PlanarVelocity< NumericType > &planar_velocity_2)
 Constructor. Constructs an angle by computing the angle between two given planar velocities. More...
 
 Angle (const Position< NumericType > &position1, const Position< NumericType > &position2)
 Constructor. Constructs an angle by computing the angle between two given positions. More...
 
 Angle (const TemperatureGradient< NumericType > &temperature_gradient_1, const TemperatureGradient< NumericType > &temperature_gradient_2)
 Constructor. Constructs an angle by computing the angle between two given temperature gradients. More...
 
 Angle (const Traction< NumericType > &traction1, const Traction< NumericType > &traction2)
 Constructor. Constructs an angle by computing the angle between two given tractions. More...
 
 Angle (const Velocity< NumericType > &velocity1, const Velocity< NumericType > &velocity2)
 Constructor. Constructs an angle by computing the angle between two given velocities. More...
 
 ~Angle () noexcept=default
 Destructor. Destroys this angle. More...
 
constexpr Angle (const Angle< NumericType > &other)=default
 Copy constructor. Constructs an angle by copying another one. More...
 
template<typename OtherNumericType >
constexpr Angle (const Angle< OtherNumericType > &other)
 Copy constructor. Constructs an angle by copying another one. More...
 
constexpr Angle (Angle< NumericType > &&other) noexcept=default
 Move constructor. Constructs an angle by moving another one. More...
 
constexpr Angle< NumericType > & operator= (const Angle< NumericType > &other)=default
 Copy assignment operator. Assigns this angle by copying another one. More...
 
template<typename OtherNumericType >
constexpr Angle< NumericType > & operator= (const Angle< OtherNumericType > &other)
 Copy assignment operator. Assigns this angle by copying another one. More...
 
constexpr Angle< NumericType > & operator= (Angle< NumericType > &&other) noexcept=default
 Move assignment operator. Assigns this angle by moving another one. More...
 
constexpr Angle< NumericType > operator+ (const Angle< NumericType > &other) const
 
constexpr Angle< NumericType > operator- (const Angle< NumericType > &other) const
 
constexpr Angle< NumericType > operator* (const NumericType number) const
 
constexpr AngularSpeed< NumericType > operator* (const Frequency< NumericType > &frequency) const
 
constexpr Angle< NumericType > operator/ (const NumericType number) const
 
constexpr AngularSpeed< NumericType > operator/ (const Time< NumericType > &time) const
 
constexpr Time< NumericType > operator/ (const AngularSpeed< NumericType > &angular_speed) const
 
constexpr NumericType operator/ (const Angle< NumericType > &other) const noexcept
 
constexpr void operator+= (const Angle< NumericType > &other) noexcept
 
constexpr void operator-= (const Angle< NumericType > &other) 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::Angle 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::Angle 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::Angle 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::Angle 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::Angle 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 Angle< NumericType > Zero ()
 Statically creates an angle of zero. More...
 
template<Unit::Angle Unit>
static constexpr Angle< NumericType > Create (const NumericType value)
 Statically creates an angle with a given value expressed in a given angle unit. More...
 
static constexpr const PhQ::DimensionsDimensions ()
 Physical dimension set of this physical quantity. More...
 
static constexpr Unit::Angle 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 Angle (const NumericType value)
 Constructor. Constructs an angle with a given value expressed in the standard angle unit. More...
 

Detailed Description

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

Plane angle between two lines or dihedral angle between two planes.

Definition at line 130 of file Angle.hpp.

Constructor & Destructor Documentation

◆ Angle() [1/33]

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

Default constructor. Constructs an angle with an uninitialized value.

◆ Angle() [2/33]

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

Constructor. Constructs an angle with a given value expressed in a given angle unit.

Definition at line 136 of file Angle.hpp.

◆ Angle() [3/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const PlanarVector< NumericType > &  planar_vector_1,
const PlanarVector< NumericType > &  planar_vector_2 
)
inline

Constructor. Constructs an angle by computing the angle between two given planar vectors.

Definition at line 141 of file Angle.hpp.

◆ Angle() [4/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const Vector< NumericType > &  vector1,
const Vector< NumericType > &  vector2 
)
inline

Constructor. Constructs an angle by computing the angle between two given vectors.

Definition at line 147 of file Angle.hpp.

◆ Angle() [5/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const PlanarVector< NumericType > &  planar_vector,
const PlanarDirection< NumericType > &  planar_direction 
)

Constructor. Constructs an angle by computing the angle between a given planar vector and planar direction.

◆ Angle() [6/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const Vector< NumericType > &  vector,
const Direction< NumericType > &  direction 
)

Constructor. Constructs an angle by computing the angle between a given vector and direction.

◆ Angle() [7/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const PlanarDirection< NumericType > &  planar_direction,
const PlanarVector< NumericType > &  planar_vector 
)

Constructor. Constructs an angle by computing the angle between a given planar direction and planar vector.

◆ Angle() [8/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const Direction< NumericType > &  direction,
const Vector< NumericType > &  vector 
)

Constructor. Constructs an angle by computing the angle between a given direction and vector.

◆ Angle() [9/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const PlanarDirection< NumericType > &  planar_direction_1,
const PlanarDirection< NumericType > &  planar_direction_2 
)

Constructor. Constructs an angle by computing the angle between two given planar directions.

◆ Angle() [10/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const Direction< NumericType > &  direction1,
const Direction< NumericType > &  direction2 
)

Constructor. Constructs an angle by computing the angle between two given directions.

◆ Angle() [11/33]

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

Constructor. Constructs an angle from a given angular speed and time using the definition of angular speed.

◆ Angle() [12/33]

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

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

◆ Angle() [13/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const Acceleration< NumericType > &  acceleration1,
const Acceleration< NumericType > &  acceleration2 
)

Constructor. Constructs an angle by computing the angle between two given acceleration vectors.

◆ Angle() [14/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const VectorArea< NumericType > &  vector_area_1,
const VectorArea< NumericType > &  vector_area_2 
)

Constructor. Constructs an angle by computing the angle between two given vector areas.

◆ Angle() [15/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const Displacement< NumericType > &  displacement1,
const Displacement< NumericType > &  displacement2 
)

Constructor. Constructs an angle by computing the angle between two given displacements.

◆ Angle() [16/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const Force< NumericType > &  force1,
const Force< NumericType > &  force2 
)

Constructor. Constructs an angle by computing the angle between two given forces.

◆ Angle() [17/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const HeatFlux< NumericType > &  heat_flux_1,
const HeatFlux< NumericType > &  heat_flux_2 
)

Constructor. Constructs an angle by computing the angle between two given heat fluxes.

◆ Angle() [18/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const PlanarAcceleration< NumericType > &  planar_acceleration_1,
const PlanarAcceleration< NumericType > &  planar_acceleration_2 
)

Constructor. Constructs an angle by computing the angle between two given planar acceleration vectors.

◆ Angle() [19/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const PlanarDisplacement< NumericType > &  planar_displacement_1,
const PlanarDisplacement< NumericType > &  planar_displacement_2 
)

Constructor. Constructs an angle by computing the angle between two given planar displacements.

◆ Angle() [20/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const PlanarForce< NumericType > &  planar_force_1,
const PlanarForce< NumericType > &  planar_force_2 
)

Constructor. Constructs an angle by computing the angle between two given planar forces.

◆ Angle() [21/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const PlanarHeatFlux< NumericType > &  planar_heat_flux_1,
const PlanarHeatFlux< NumericType > &  planar_heat_flux_2 
)

Constructor. Constructs an angle by computing the angle between two given planar heat fluxes.

◆ Angle() [22/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const PlanarPosition< NumericType > &  planar_position_1,
const PlanarPosition< NumericType > &  planar_position_2 
)

Constructor. Constructs an angle by computing the angle between two given planar positions.

◆ Angle() [23/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const PlanarTemperatureGradient< NumericType > &  planar_temperature_gradient_1,
const PlanarTemperatureGradient< NumericType > &  planar_temperature_gradient_2 
)

Constructor. Constructs an angle by computing the angle between two given planar temperature gradients.

◆ Angle() [24/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const PlanarTraction< NumericType > &  planar_traction_1,
const PlanarTraction< NumericType > &  planar_traction_2 
)

Constructor. Constructs an angle by computing the angle between two given planar tractions.

◆ Angle() [25/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const PlanarVelocity< NumericType > &  planar_velocity_1,
const PlanarVelocity< NumericType > &  planar_velocity_2 
)

Constructor. Constructs an angle by computing the angle between two given planar velocities.

◆ Angle() [26/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const Position< NumericType > &  position1,
const Position< NumericType > &  position2 
)

Constructor. Constructs an angle by computing the angle between two given positions.

◆ Angle() [27/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const TemperatureGradient< NumericType > &  temperature_gradient_1,
const TemperatureGradient< NumericType > &  temperature_gradient_2 
)

Constructor. Constructs an angle by computing the angle between two given temperature gradients.

◆ Angle() [28/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const Traction< NumericType > &  traction1,
const Traction< NumericType > &  traction2 
)

Constructor. Constructs an angle by computing the angle between two given tractions.

◆ Angle() [29/33]

template<typename NumericType = double>
PhQ::Angle< NumericType >::Angle ( const Velocity< NumericType > &  velocity1,
const Velocity< NumericType > &  velocity2 
)

Constructor. Constructs an angle by computing the angle between two given velocities.

◆ ~Angle()

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

Destructor. Destroys this angle.

◆ Angle() [30/33]

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

Copy constructor. Constructs an angle by copying another one.

◆ Angle() [31/33]

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

Copy constructor. Constructs an angle by copying another one.

Definition at line 266 of file Angle.hpp.

◆ Angle() [32/33]

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

Move constructor. Constructs an angle by moving another one.

◆ Angle() [33/33]

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

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

Definition at line 341 of file Angle.hpp.

Member Function Documentation

◆ Create()

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

Statically creates an angle with a given value expressed in a given angle unit.

Definition at line 292 of file Angle.hpp.

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

◆ Dimensions()

static constexpr const PhQ::Dimensions& PhQ::DimensionalScalar< Unit::Angle , 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::Angle , 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::Angle , double >::JSON ( const Unit::Angle  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::Angle , 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/2]

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

◆ operator*() [2/2]

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

Definition at line 304 of file Angle.hpp.

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

◆ operator*=()

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

Definition at line 330 of file Angle.hpp.

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

◆ operator+()

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

◆ operator+=()

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

Definition at line 322 of file Angle.hpp.

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

◆ operator-()

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

◆ operator-=()

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

Definition at line 326 of file Angle.hpp.

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

◆ operator/() [1/4]

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

Definition at line 318 of file Angle.hpp.

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

◆ operator/() [2/4]

template<typename NumericType = double>
constexpr Time<NumericType> PhQ::Angle< NumericType >::operator/ ( const AngularSpeed< NumericType > &  angular_speed) const
constexpr

◆ operator/() [3/4]

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

Definition at line 310 of file Angle.hpp.

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

◆ operator/() [4/4]

template<typename NumericType = double>
constexpr AngularSpeed<NumericType> PhQ::Angle< NumericType >::operator/ ( const Time< NumericType > &  time) const
constexpr

◆ operator/=()

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

Definition at line 334 of file Angle.hpp.

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

◆ operator=() [1/3]

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

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

◆ operator=() [2/3]

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

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

◆ operator=() [3/3]

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

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

Definition at line 277 of file Angle.hpp.

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

◆ Print() [1/2]

std::string PhQ::DimensionalScalar< Unit::Angle , 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::Angle , double >::Print ( const Unit::Angle  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::Angle , 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::Angle , 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::Angle PhQ::DimensionalScalar< Unit::Angle , 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::Angle , 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::Angle , double >::Value ( const Unit::Angle  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::Angle , 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::Angle , double >::XML ( const Unit::Angle  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::Angle , 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::Angle , double >::YAML ( const Unit::Angle  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 Angle<NumericType> PhQ::Angle< NumericType >::Zero ( )
inlinestaticconstexpr

Statically creates an angle of zero.

Definition at line 286 of file Angle.hpp.

Member Data Documentation

◆ value

double PhQ::DimensionalScalar< Unit::Angle , 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 file: