math::SVec3 Class Reference

A class representing a vector in spherical coordinates. More...

#include "geometry_ops.h"

Public Member Functions
	SVec3 () noexcept=default
	SVec3 (const SVec3 &) noexcept=default
	SVec3 (SVec3 &&) noexcept=default
SVec3 &	operator= (const SVec3 &) noexcept=default
SVec3 &	operator= (SVec3 &&) noexcept=default
constexpr	SVec3 (const RealType vector_length, const RealType vector_azimuth, const RealType vector_elevation) noexcept
	Parameterized constructor for SVec3.
	SVec3 (const Vec3 &vec) noexcept
	Constructs a spherical vector from a rectangular Vec3.
SVec3 &	operator*= (RealType b) noexcept
	Scalar multiplication assignment for SVec3.
SVec3 &	operator/= (RealType b) noexcept
	Scalar division assignment for SVec3.

Public Attributes
RealType	length {}
	The length of the vector.
RealType	azimuth {}
	The azimuth angle of the vector.
RealType	elevation {}
	The elevation angle of the vector.

Detailed Description

A class representing a vector in spherical coordinates.

Definition at line 52 of file geometry_ops.h.

Constructor & Destructor Documentation

SVec3() [1/5]

math::SVec3::SVec3 ( )

defaultnoexcept

SVec3() [2/5]

math::SVec3::SVec3 ( const SVec3 &  )

defaultnoexcept

SVec3() [3/5]

math::SVec3::SVec3 ( SVec3 &&  )

defaultnoexcept

SVec3() [4/5]

constexpr math::SVec3::SVec3 ( const RealType  vector_length, const RealType  vector_azimuth, const RealType  vector_elevation  )

constexprnoexcept

Parameterized constructor for SVec3.

Parameters

vector_length	The length or magnitude of the vector.
vector_azimuth	The azimuthal angle of the vector.
vector_elevation	The elevation angle of the vector.

Definition at line 72 of file geometry_ops.h.

                                                                  :
            length(vector_length), azimuth(vector_azimuth), elevation(vector_elevation)
        {
        }

SVec3() [5/5]

math::SVec3::SVec3 ( const Vec3 &  vec )

explicitnoexcept

Constructs a spherical vector from a rectangular Vec3.

Parameters

vec	A rectangular vector (Vec3) to convert.

Definition at line 73 of file geometry_ops.cpp.

                                         : length(vec.length())
    {
        elevation = std::asin(vec.z / length);
        azimuth = std::atan2(vec.y, vec.x);
    }

Member Function Documentation

operator*=()

SVec3 & math::SVec3::operator*= ( RealType  b )

noexcept

Scalar multiplication assignment for SVec3.

Parameters

b	The scalar value.

Returns

A reference to the updated SVec3.

Definition at line 79 of file geometry_ops.cpp.

    {
        length *= b;
        return *this;
    }

operator/=()

SVec3 & math::SVec3::operator/= ( RealType  b )

noexcept

Scalar division assignment for SVec3.

Parameters

b	The scalar value.

Returns

A reference to the updated SVec3.

Definition at line 85 of file geometry_ops.cpp.

    {
        length /= b;
        return *this;
    }

operator=() [1/2]

SVec3 & math::SVec3::operator= ( const SVec3 &  )

defaultnoexcept

operator=() [2/2]

SVec3 & math::SVec3::operator= ( SVec3 &&  )

defaultnoexcept

Member Data Documentation

azimuth

RealType math::SVec3::azimuth {}

The azimuth angle of the vector.

Definition at line 56 of file geometry_ops.h.

{}; ///< The azimuth angle of the vector

Referenced by fers_get_interpolated_rotation_path(), serial::kml_generator_utils::generateDirectionalAntennaKml(), antenna::Gaussian::getGain(), antenna::XmlAntenna::getGain(), antenna::H5Antenna::getGain(), and radar::FileTarget::getRcs().

elevation

RealType math::SVec3::elevation {}

The elevation angle of the vector.

Definition at line 57 of file geometry_ops.h.

{}; ///< The elevation angle of the vector

Referenced by fers_get_interpolated_rotation_path(), serial::kml_generator_utils::generateDirectionalAntennaKml(), antenna::Gaussian::getGain(), antenna::XmlAntenna::getGain(), antenna::H5Antenna::getGain(), and radar::FileTarget::getRcs().

length

RealType math::SVec3::length {}

The length of the vector.

Definition at line 55 of file geometry_ops.h.

{}; ///< The length of the vector

Referenced by antenna::Antenna::getAngle().

---

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

• packages/libfers/src/math/geometry_ops.h
• packages/libfers/src/math/geometry_ops.cpp