helios::SphericalCoord Struct Reference

Vector of spherical coordinates (elevation,azimuth) More...

#include <helios_vector_types.h>

Public Member Functions
	SphericalCoord ()
	Default constructor.
	SphericalCoord (float radius, float elevation_radians, float azimuth_radians)
	Initialize SphericalCoord by specifying radius, elevation, and azimuth.
	SphericalCoord (const SphericalCoord &c)
	Copy constructor.
SphericalCoord &	operator= (const SphericalCoord &c) noexcept
	Assignment operator.
bool	operator== (const helios::SphericalCoord &c) const noexcept
	check for equality of two spherical coordinates
bool	operator!= (const helios::SphericalCoord &c) const noexcept
	check for inequality of two spherical coordinates

Data Fields
float	radius
	Radius.
const float &	elevation
	Elevation angle (radians)
const float &	zenith
	Zenithal angle (radians)
float	azimuth
	Azimuthal angle (radians)

Friends
std::ostream &	operator<< (std::ostream &os, helios::SphericalCoord const &coord)
	Write SphericalCoord to output stream.

Detailed Description

Vector of spherical coordinates (elevation,azimuth)

Definition at line 1996 of file helios_vector_types.h.

Constructor & Destructor Documentation

SphericalCoord() [1/3]

helios::SphericalCoord::SphericalCoord ( )

inline

Default constructor.

initializes to vertical unit vector

Definition at line 2019 of file helios_vector_types.h.

SphericalCoord() [2/3]

helios::SphericalCoord::SphericalCoord ( float  radius, float  elevation_radians, float  azimuth_radians  )

inline

Initialize SphericalCoord by specifying radius, elevation, and azimuth.

Parameters

[in]	radius	Radius
[in]	elevation_radians	Elevation angle (radians)
[in]	azimuth_radians	Azimuthal angle (radians)

Definition at line 2029 of file helios_vector_types.h.

SphericalCoord() [3/3]

helios::SphericalCoord::SphericalCoord ( const SphericalCoord &  c )

inline

Copy constructor.

Definition at line 2034 of file helios_vector_types.h.

Member Function Documentation

operator!=()

bool helios::SphericalCoord::operator!= ( const helios::SphericalCoord &  c ) const

inlinenoexcept

check for inequality of two spherical coordinates

Definition at line 2087 of file helios_vector_types.h.

operator=()

SphericalCoord & helios::SphericalCoord::operator= ( const SphericalCoord &  c )

inlinenoexcept

Assignment operator.

Definition at line 2038 of file helios_vector_types.h.

operator==()

bool helios::SphericalCoord::operator== ( const helios::SphericalCoord &  c ) const

inlinenoexcept

check for equality of two spherical coordinates

Definition at line 2083 of file helios_vector_types.h.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, helios::SphericalCoord const &  coord  )

friend

Write SphericalCoord to output stream.

Definition at line 2054 of file helios_vector_types.h.

Field Documentation

azimuth

float helios::SphericalCoord::azimuth

Azimuthal angle (radians)

Definition at line 2015 of file helios_vector_types.h.

elevation

const float& helios::SphericalCoord::elevation

Elevation angle (radians)

Note

Elevation angle is read-only, since it is linked to the zenith angle.

Definition at line 2008 of file helios_vector_types.h.

radius

float helios::SphericalCoord::radius

Radius.

Definition at line 2003 of file helios_vector_types.h.

zenith

const float& helios::SphericalCoord::zenith

Zenithal angle (radians)

Note

Zenith angle is read-only, since it is linked to the elevation angle.

Definition at line 2013 of file helios_vector_types.h.

---

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

• core/include/helios_vector_types.h