Two-dimensional Euclidean acceleration vector in the XY plane. Contains two components in Cartesian coordinates: x and y. For a three-dimensional Euclidean acceleration vector, see PhQ::Acceleration. For scalar acceleration components or for the magnitude of an acceleration vector, see PhQ::ScalarAcceleration. More...

#include "PlanarAcceleration.hpp"

Public Member Functions
	PlanarAcceleration ()=default
	Default constructor. Constructs a planar acceleration vector with an uninitialized value. More...

	PlanarAcceleration (const PlanarVector< NumericType > &value, const Unit::Acceleration unit)
	Constructor. Constructs a planar acceleration vector with a given value expressed in a given acceleration unit. More...

	PlanarAcceleration (const ScalarAcceleration< NumericType > &x, const ScalarAcceleration< NumericType > &y)
	Constructor. Constructs a planar acceleration vector from a given set of scalar acceleration components. More...

constexpr	PlanarAcceleration (const ScalarAcceleration< NumericType > &scalar_acceleration, const PlanarDirection< NumericType > &planar_direction)
	Constructor. Constructs a planar acceleration vector from a given scalar acceleration magnitude and planar direction. More...

constexpr	PlanarAcceleration (const Acceleration< NumericType > &acceleration)
	Constructor. Constructs a planar acceleration vector from a given acceleration vector by projecting the acceleration vector onto the XY plane. More...

constexpr	PlanarAcceleration (const PlanarVelocity< NumericType > &planar_velocity, const Time< NumericType > &time)
	Constructor. Constructs a planar acceleration vector from a given planar velocity and time using the definition of acceleration. More...

constexpr	PlanarAcceleration (const PlanarVelocity< NumericType > &planar_velocity, const Frequency< NumericType > &frequency)
	Constructor. Constructs a planar acceleration vector from a given planar velocity and frequency using the definition of acceleration. More...

	~PlanarAcceleration () noexcept=default
	Destructor. Destroys this acceleration vector. More...

constexpr	PlanarAcceleration (const PlanarAcceleration< NumericType > &other)=default
	Copy constructor. Constructs a planar acceleration vector by copying another one. More...

template<typename OtherNumericType >
constexpr	PlanarAcceleration (const PlanarAcceleration< OtherNumericType > &other)
	Copy constructor. Constructs a planar acceleration vector by copying another one. More...

constexpr	PlanarAcceleration (PlanarAcceleration< NumericType > &&other) noexcept=default
	Move constructor. Constructs a planar acceleration vector by moving another one. More...

constexpr PlanarAcceleration< NumericType > &	operator= (const PlanarAcceleration< NumericType > &other)=default
	Copy assignment operator. Assigns this acceleration vector by copying another one. More...

template<typename OtherNumericType >
constexpr PlanarAcceleration< NumericType > &	operator= (const PlanarAcceleration< OtherNumericType > &other)
	Copy assignment operator. Assigns this acceleration vector by copying another one. More...

constexpr PlanarAcceleration< NumericType > &	operator= (PlanarAcceleration< NumericType > &&other) noexcept=default
	Move assignment operator. Assigns this acceleration vector by moving another one. More...

constexpr ScalarAcceleration< NumericType >	x () const noexcept
	Returns the x Cartesian component of this acceleration vector. More...

constexpr ScalarAcceleration< NumericType >	y () const noexcept
	Returns the y Cartesian component of this acceleration vector. More...

ScalarAcceleration< NumericType >	Magnitude () const
	Returns the magnitude of this acceleration vector. More...

PhQ::PlanarDirection< NumericType >	PlanarDirection () const
	Returns the planar direction of this acceleration vector. More...

PhQ::Angle< NumericType >	Angle (const PlanarAcceleration< NumericType > &other) const
	Returns the angle between this acceleration vector and another one. More...

constexpr PlanarAcceleration< NumericType >	operator+ (const PlanarAcceleration< NumericType > &other) const

constexpr PlanarAcceleration< NumericType >	operator- (const PlanarAcceleration< NumericType > &other) const

constexpr PlanarAcceleration< NumericType >	operator* (const NumericType number) const

constexpr PlanarVelocity< NumericType >	operator* (const Time< NumericType > &time) const

constexpr PlanarAcceleration< NumericType >	operator/ (const NumericType number) const

constexpr PlanarVelocity< NumericType >	operator/ (const Frequency< NumericType > &frequency) const

constexpr void	operator+= (const PlanarAcceleration< NumericType > &other) noexcept

constexpr void	operator-= (const PlanarAcceleration< NumericType > &other) noexcept

constexpr void	operator*= (const NumericType number) noexcept

constexpr void	operator/= (const NumericType number) noexcept

constexpr const PhQ::PlanarVector< double > &	Value () const noexcept
	Value of this physical quantity expressed in its standard unit of measure. More...

PhQ::PlanarVector< double >	Value (const Unit::Acceleration unit) const
	Value of this physical quantity expressed in a given unit of measure. More...

constexpr PhQ::PlanarVector< 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 PhQ::PlanarVector< 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 PhQ::PlanarVector< 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::Acceleration 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::Acceleration 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::Acceleration 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::Acceleration 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 PlanarAcceleration< NumericType >	Zero ()
	Statically creates a planar acceleration vector of zero. More...

template<Unit::Acceleration Unit>
static constexpr PlanarAcceleration< NumericType >	Create (const NumericType x, const NumericType y)
	Statically creates a planar acceleration vector from the given x and y Cartesian components expressed in a given acceleration unit. More...

template<Unit::Acceleration Unit>
static constexpr PlanarAcceleration< NumericType >	Create (const std::array< NumericType, 2 > &x_y)
	Statically creates a planar acceleration vector from the given x and y Cartesian components expressed in a given acceleration unit. More...

template<Unit::Acceleration Unit>
static constexpr PlanarAcceleration< NumericType >	Create (const PlanarVector< NumericType > &value)
	Statically creates a planar acceleration vector with a given value expressed in a given acceleration unit. More...

static constexpr const PhQ::Dimensions &	Dimensions ()
	Physical dimension set of this physical quantity. More...

static constexpr Unit::Acceleration	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
PhQ::PlanarVector< double >	value
	Value of this physical quantity expressed in its standard unit of measure. More...

Private Member Functions
constexpr	PlanarAcceleration (const PlanarVector< NumericType > &value)
	Constructor. Constructs a planar acceleration vector with a given value expressed in the standard acceleration unit. More...

Detailed Description

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

Two-dimensional Euclidean acceleration vector in the XY plane. Contains two components in Cartesian coordinates: x and y. For a three-dimensional Euclidean acceleration vector, see PhQ::Acceleration. For scalar acceleration components or for the magnitude of an acceleration vector, see PhQ::ScalarAcceleration.

Definition at line 50 of file PlanarAcceleration.hpp.

Constructor & Destructor Documentation

◆ PlanarAcceleration() [1/11]

template<typename NumericType = double>

PhQ::PlanarAcceleration< NumericType >::PlanarAcceleration ( )

default

Default constructor. Constructs a planar acceleration vector with an uninitialized value.

◆ PlanarAcceleration() [2/11]

template<typename NumericType = double>

PhQ::PlanarAcceleration< NumericType >::PlanarAcceleration	(	const PlanarVector< NumericType > &	value,
		const Unit::Acceleration	unit
	)

inline

Constructor. Constructs a planar acceleration vector with a given value expressed in a given acceleration unit.

Definition at line 58 of file PlanarAcceleration.hpp.

◆ PlanarAcceleration() [3/11]

template<typename NumericType = double>

PhQ::PlanarAcceleration< NumericType >::PlanarAcceleration	(	const ScalarAcceleration< NumericType > &	x,
		const ScalarAcceleration< NumericType > &	y
	)

inline

Constructor. Constructs a planar acceleration vector from a given set of scalar acceleration components.

Definition at line 63 of file PlanarAcceleration.hpp.

References PhQ::PlanarAcceleration< NumericType >::x(), and PhQ::PlanarAcceleration< NumericType >::y().

◆ PlanarAcceleration() [4/11]

template<typename NumericType = double>

constexpr PhQ::PlanarAcceleration< NumericType >::PlanarAcceleration	(	const ScalarAcceleration< NumericType > &	scalar_acceleration,
		const PlanarDirection< NumericType > &	planar_direction
	)

inlineconstexpr

Constructor. Constructs a planar acceleration vector from a given scalar acceleration magnitude and planar direction.

Definition at line 69 of file PlanarAcceleration.hpp.

◆ PlanarAcceleration() [5/11]

template<typename NumericType >

constexpr PhQ::PlanarAcceleration< NumericType >::PlanarAcceleration ( const Acceleration< NumericType > & acceleration )

inlineexplicitconstexpr

Constructor. Constructs a planar acceleration vector from a given acceleration vector by projecting the acceleration vector onto the XY plane.

Definition at line 287 of file Acceleration.hpp.

References PhQ::DimensionalVector< UnitType, NumericType >::Value().

◆ PlanarAcceleration() [6/11]

template<typename NumericType = double>

constexpr PhQ::PlanarAcceleration< NumericType >::PlanarAcceleration	(	const PlanarVelocity< NumericType > &	planar_velocity,
		const Time< NumericType > &	time
	)

inlineconstexpr

Constructor. Constructs a planar acceleration vector from a given planar velocity and time using the definition of acceleration.

Definition at line 79 of file PlanarAcceleration.hpp.

◆ PlanarAcceleration() [7/11]

template<typename NumericType = double>

constexpr PhQ::PlanarAcceleration< NumericType >::PlanarAcceleration	(	const PlanarVelocity< NumericType > &	planar_velocity,
		const Frequency< NumericType > &	frequency
	)

inlineconstexpr

Constructor. Constructs a planar acceleration vector from a given planar velocity and frequency using the definition of acceleration.

Definition at line 85 of file PlanarAcceleration.hpp.

◆ ~PlanarAcceleration()

template<typename NumericType = double>

PhQ::PlanarAcceleration< NumericType >::~PlanarAcceleration ( )

defaultnoexcept

Destructor. Destroys this acceleration vector.

◆ PlanarAcceleration() [8/11]

template<typename NumericType = double>

constexpr PhQ::PlanarAcceleration< NumericType >::PlanarAcceleration ( const PlanarAcceleration< NumericType > & other )

constexprdefault

Copy constructor. Constructs a planar acceleration vector by copying another one.

◆ PlanarAcceleration() [9/11]

template<typename NumericType = double>

template<typename OtherNumericType >

constexpr PhQ::PlanarAcceleration< NumericType >::PlanarAcceleration ( const PlanarAcceleration< OtherNumericType > & other )

inlineexplicitconstexpr

Copy constructor. Constructs a planar acceleration vector by copying another one.

Definition at line 97 of file PlanarAcceleration.hpp.

◆ PlanarAcceleration() [10/11]

template<typename NumericType = double>

constexpr PhQ::PlanarAcceleration< NumericType >::PlanarAcceleration ( PlanarAcceleration< NumericType > && other )

constexprdefaultnoexcept

Move constructor. Constructs a planar acceleration vector by moving another one.

◆ PlanarAcceleration() [11/11]

template<typename NumericType = double>

constexpr PhQ::PlanarAcceleration< NumericType >::PlanarAcceleration ( const PlanarVector< NumericType > & value )

inlineexplicitconstexprprivate

Constructor. Constructs a planar acceleration vector with a given value expressed in the standard acceleration unit.

Definition at line 223 of file PlanarAcceleration.hpp.

Member Function Documentation

◆ Angle()

template<typename NumericType = double>

PhQ::Angle<NumericType> PhQ::PlanarAcceleration< NumericType >::Angle ( const PlanarAcceleration< NumericType > & other ) const

inline

Returns the angle between this acceleration vector and another one.

Definition at line 174 of file PlanarAcceleration.hpp.

◆ Create() [1/3]

template<typename NumericType = double>

template<Unit::Acceleration Unit>

static constexpr PlanarAcceleration<NumericType> PhQ::PlanarAcceleration< NumericType >::Create	(	const NumericType	x,
		const NumericType	y
	)

inlinestaticconstexpr

Statically creates a planar acceleration vector from the given x and y Cartesian components expressed in a given acceleration unit.

Definition at line 127 of file PlanarAcceleration.hpp.

References PhQ::PlanarAcceleration< NumericType >::x(), and PhQ::PlanarAcceleration< NumericType >::y().

◆ Create() [2/3]

template<typename NumericType = double>

template<Unit::Acceleration Unit>

static constexpr PlanarAcceleration<NumericType> PhQ::PlanarAcceleration< NumericType >::Create ( const PlanarVector< NumericType > & value )

inlinestaticconstexpr

Statically creates a planar acceleration vector with a given value expressed in a given acceleration unit.

Definition at line 147 of file PlanarAcceleration.hpp.

References PhQ::DimensionalPlanarVector< Unit::Acceleration, double >::value.

◆ Create() [3/3]

template<typename NumericType = double>

template<Unit::Acceleration Unit>

static constexpr PlanarAcceleration<NumericType> PhQ::PlanarAcceleration< NumericType >::Create ( const std::array< NumericType, 2 > & x_y )

inlinestaticconstexpr

Statically creates a planar acceleration vector from the given x and y Cartesian components expressed in a given acceleration unit.

Definition at line 137 of file PlanarAcceleration.hpp.

◆ Dimensions()

static constexpr const PhQ::Dimensions& PhQ::DimensionalPlanarVector< Unit::Acceleration , double >::Dimensions ( )

inlinestaticconstexprinherited

Physical dimension set of this physical quantity.

Definition at line 50 of file DimensionalPlanarVector.hpp.

◆ JSON() [1/2]

std::string PhQ::DimensionalPlanarVector< Unit::Acceleration , 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 103 of file DimensionalPlanarVector.hpp.

◆ JSON() [2/2]

std::string PhQ::DimensionalPlanarVector< Unit::Acceleration , double >::JSON ( const Unit::Acceleration 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 113 of file DimensionalPlanarVector.hpp.

◆ Magnitude()

template<typename NumericType = double>

ScalarAcceleration<NumericType> PhQ::PlanarAcceleration< NumericType >::Magnitude ( ) const

inline

Returns the magnitude of this acceleration vector.

Definition at line 164 of file PlanarAcceleration.hpp.

References PhQ::PlanarVector< NumericType >::Magnitude(), and PhQ::DimensionalPlanarVector< Unit::Acceleration, double >::value.

◆ MutableValue()

constexpr PhQ::PlanarVector<double >& PhQ::DimensionalPlanarVector< Unit::Acceleration , double >::MutableValue ( )

inlineconstexprnoexceptinherited

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

Definition at line 79 of file DimensionalPlanarVector.hpp.

◆ operator*() [1/2]

template<typename NumericType = double>

constexpr PlanarAcceleration<NumericType> PhQ::PlanarAcceleration< NumericType >::operator* ( const NumericType number ) const

inlineconstexpr

Definition at line 188 of file PlanarAcceleration.hpp.

References PhQ::DimensionalPlanarVector< Unit::Acceleration, double >::value.

◆ operator*() [2/2]

template<typename NumericType = double>

constexpr PlanarVelocity<NumericType> PhQ::PlanarAcceleration< NumericType >::operator* ( const Time< NumericType > & time ) const

inlineconstexpr

Definition at line 192 of file PlanarAcceleration.hpp.

◆ operator*=()

template<typename NumericType = double>

constexpr void PhQ::PlanarAcceleration< NumericType >::operator*= ( const NumericType number )

inlineconstexprnoexcept

Definition at line 212 of file PlanarAcceleration.hpp.

References PhQ::DimensionalPlanarVector< Unit::Acceleration, double >::value.

◆ operator+()

template<typename NumericType = double>

constexpr PlanarAcceleration<NumericType> PhQ::PlanarAcceleration< NumericType >::operator+ ( const PlanarAcceleration< NumericType > & other ) const

inlineconstexpr

Definition at line 178 of file PlanarAcceleration.hpp.

References PhQ::DimensionalPlanarVector< UnitType, NumericType >::value, and PhQ::DimensionalPlanarVector< Unit::Acceleration, double >::value.

◆ operator+=()

template<typename NumericType = double>

constexpr void PhQ::PlanarAcceleration< NumericType >::operator+= ( const PlanarAcceleration< NumericType > & other )

inlineconstexprnoexcept

Definition at line 204 of file PlanarAcceleration.hpp.

References PhQ::DimensionalPlanarVector< Unit::Acceleration, double >::value.

◆ operator-()

template<typename NumericType = double>

constexpr PlanarAcceleration<NumericType> PhQ::PlanarAcceleration< NumericType >::operator- ( const PlanarAcceleration< NumericType > & other ) const

inlineconstexpr

Definition at line 183 of file PlanarAcceleration.hpp.

References PhQ::DimensionalPlanarVector< UnitType, NumericType >::value, and PhQ::DimensionalPlanarVector< Unit::Acceleration, double >::value.

◆ operator-=()

template<typename NumericType = double>

constexpr void PhQ::PlanarAcceleration< NumericType >::operator-= ( const PlanarAcceleration< NumericType > & other )

inlineconstexprnoexcept

Definition at line 208 of file PlanarAcceleration.hpp.

References PhQ::DimensionalPlanarVector< Unit::Acceleration, double >::value.

◆ operator/() [1/2]

template<typename NumericType = double>

constexpr PlanarVelocity<NumericType> PhQ::PlanarAcceleration< NumericType >::operator/ ( const Frequency< NumericType > & frequency ) const

inlineconstexpr

Definition at line 200 of file PlanarAcceleration.hpp.

◆ operator/() [2/2]

template<typename NumericType = double>

constexpr PlanarAcceleration<NumericType> PhQ::PlanarAcceleration< NumericType >::operator/ ( const NumericType number ) const

inlineconstexpr

Definition at line 196 of file PlanarAcceleration.hpp.

References PhQ::DimensionalPlanarVector< Unit::Acceleration, double >::value.

◆ operator/=()

template<typename NumericType = double>

constexpr void PhQ::PlanarAcceleration< NumericType >::operator/= ( const NumericType number )

inlineconstexprnoexcept

Definition at line 216 of file PlanarAcceleration.hpp.

References PhQ::DimensionalPlanarVector< Unit::Acceleration, double >::value.

◆ operator=() [1/3]

template<typename NumericType = double>

constexpr PlanarAcceleration<NumericType>& PhQ::PlanarAcceleration< NumericType >::operator= ( const PlanarAcceleration< NumericType > & other )

constexprdefault

Copy assignment operator. Assigns this acceleration vector by copying another one.

◆ operator=() [2/3]

template<typename NumericType = double>

template<typename OtherNumericType >

constexpr PlanarAcceleration<NumericType>& PhQ::PlanarAcceleration< NumericType >::operator= ( const PlanarAcceleration< OtherNumericType > & other )

inlineconstexpr

Copy assignment operator. Assigns this acceleration vector by copying another one.

Definition at line 109 of file PlanarAcceleration.hpp.

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

◆ operator=() [3/3]

template<typename NumericType = double>

constexpr PlanarAcceleration<NumericType>& PhQ::PlanarAcceleration< NumericType >::operator= ( PlanarAcceleration< NumericType > && other )

constexprdefaultnoexcept

Move assignment operator. Assigns this acceleration vector by moving another one.

◆ PlanarDirection()

template<typename NumericType = double>

PhQ::PlanarDirection<NumericType> PhQ::PlanarAcceleration< NumericType >::PlanarDirection ( ) const

inline

Returns the planar direction of this acceleration vector.

Definition at line 169 of file PlanarAcceleration.hpp.

References PhQ::PlanarVector< NumericType >::PlanarDirection(), and PhQ::DimensionalPlanarVector< Unit::Acceleration, double >::value.

◆ Print() [1/2]

std::string PhQ::DimensionalPlanarVector< Unit::Acceleration , 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 91 of file DimensionalPlanarVector.hpp.

◆ Print() [2/2]

std::string PhQ::DimensionalPlanarVector< Unit::Acceleration , double >::Print ( const Unit::Acceleration 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 97 of file DimensionalPlanarVector.hpp.

◆ SetValue()

constexpr void PhQ::DimensionalPlanarVector< Unit::Acceleration , double >::SetValue ( const PhQ::PlanarVector< double > & value )

inlineconstexprnoexceptinherited

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

Definition at line 85 of file DimensionalPlanarVector.hpp.

◆ StaticValue()

constexpr PhQ::PlanarVector<double > PhQ::DimensionalPlanarVector< Unit::Acceleration , 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 73 of file DimensionalPlanarVector.hpp.

◆ Unit()

static constexpr Unit::Acceleration PhQ::DimensionalPlanarVector< Unit::Acceleration , 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 56 of file DimensionalPlanarVector.hpp.

◆ Value() [1/2]

constexpr const PhQ::PlanarVector<double >& PhQ::DimensionalPlanarVector< Unit::Acceleration , double >::Value ( ) const

inlineconstexprnoexceptinherited

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

Definition at line 61 of file DimensionalPlanarVector.hpp.

◆ Value() [2/2]

PhQ::PlanarVector<double > PhQ::DimensionalPlanarVector< Unit::Acceleration , double >::Value ( const Unit::Acceleration unit ) const

inlineinherited

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

Definition at line 66 of file DimensionalPlanarVector.hpp.

◆ x()

template<typename NumericType = double>

constexpr ScalarAcceleration<NumericType> PhQ::PlanarAcceleration< NumericType >::x ( ) const

inlineconstexprnoexcept

Returns the x Cartesian component of this acceleration vector.

Definition at line 154 of file PlanarAcceleration.hpp.

References PhQ::DimensionalPlanarVector< Unit::Acceleration, double >::value, and PhQ::PlanarVector< NumericType >::x().

Referenced by PhQ::PlanarAcceleration< NumericType >::Create(), and PhQ::PlanarAcceleration< NumericType >::PlanarAcceleration().

◆ XML() [1/2]

std::string PhQ::DimensionalPlanarVector< Unit::Acceleration , 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 123 of file DimensionalPlanarVector.hpp.

◆ XML() [2/2]

std::string PhQ::DimensionalPlanarVector< Unit::Acceleration , double >::XML ( const Unit::Acceleration 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 133 of file DimensionalPlanarVector.hpp.

◆ y()

template<typename NumericType = double>

constexpr ScalarAcceleration<NumericType> PhQ::PlanarAcceleration< NumericType >::y ( ) const

inlineconstexprnoexcept

Returns the y Cartesian component of this acceleration vector.

Definition at line 159 of file PlanarAcceleration.hpp.

References PhQ::DimensionalPlanarVector< Unit::Acceleration, double >::value, and PhQ::PlanarVector< NumericType >::y().

Referenced by PhQ::PlanarAcceleration< NumericType >::Create(), and PhQ::PlanarAcceleration< NumericType >::PlanarAcceleration().

◆ YAML() [1/2]

std::string PhQ::DimensionalPlanarVector< Unit::Acceleration , 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 143 of file DimensionalPlanarVector.hpp.

◆ YAML() [2/2]

std::string PhQ::DimensionalPlanarVector< Unit::Acceleration , double >::YAML ( const Unit::Acceleration 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 153 of file DimensionalPlanarVector.hpp.

◆ Zero()

template<typename NumericType = double>

static constexpr PlanarAcceleration<NumericType> PhQ::PlanarAcceleration< NumericType >::Zero ( )

inlinestaticconstexpr

Statically creates a planar acceleration vector of zero.

Definition at line 120 of file PlanarAcceleration.hpp.

References PhQ::PlanarVector< NumericType >::Zero().

Member Data Documentation

◆ value

PhQ::PlanarVector<double > PhQ::DimensionalPlanarVector< Unit::Acceleration , double >::value

protectedinherited

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

Definition at line 222 of file DimensionalPlanarVector.hpp.

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

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

Constructor & Destructor Documentation

◆ PlanarAcceleration() [1/11]

◆ PlanarAcceleration() [2/11]

◆ PlanarAcceleration() [3/11]

◆ PlanarAcceleration() [4/11]

◆ PlanarAcceleration() [5/11]

◆ PlanarAcceleration() [6/11]

◆ PlanarAcceleration() [7/11]

◆ ~PlanarAcceleration()

◆ PlanarAcceleration() [8/11]

◆ PlanarAcceleration() [9/11]

◆ PlanarAcceleration() [10/11]

◆ PlanarAcceleration() [11/11]

Member Function Documentation

◆ Angle()

◆ Create() [1/3]

◆ Create() [2/3]

◆ Create() [3/3]

◆ Dimensions()

◆ JSON() [1/2]

◆ JSON() [2/2]

◆ Magnitude()

◆ MutableValue()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ PlanarDirection()

◆ Print() [1/2]

◆ Print() [2/2]

◆ SetValue()

◆ StaticValue()

◆ Unit()

◆ Value() [1/2]

◆ Value() [2/2]

◆ x()

◆ XML() [1/2]

◆ XML() [2/2]

◆ y()

◆ YAML() [1/2]

◆ YAML() [2/2]

◆ Zero()

Member Data Documentation

◆ value

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