Planewave< D, T > Class Template Reference

The class owns basic plane waves informations. More...

#include <Hoa_Planewaves.hpp>

Public Member Functions
	Planewave (size_t index, T azimuth, T elevation) hoa_noexcept
	The plane wave polar constructor. More...
	Planewave (size_t index, T abscissa, T ordinate, T height) hoa_noexcept
	The plane wave cartesian constructor. More...
virtual	~Planewave () hoa_noexcept
	The plane wave destructor.
size_t	getIndex () const hoa_noexcept
	Returns the index of the plane wave.
T	getAzimuth () const hoa_noexcept
	Returns the azimuth of the planewave.
T	getElevation () const hoa_noexcept
	Returns the elevation of the planewave.
T	getAbscissa () const hoa_noexcept
	Returns the abscissa of the plane wave.
T	getOrdinate () const hoa_noexcept
	Returns the ordinate of the plane wave.
T	getHeight () const hoa_noexcept
	Returns the height of the plane wave.
void	setAzimuth (const T azimuth) hoa_noexcept
	Sets the azimuth of the plane wave. More...
void	setElevation (const T elevation) hoa_noexcept
	Set the elevation of the plane wave. More...
virtual std::string	getName () const hoa_noexcept
	Returns the name of the plane wave.

Static Public Member Functions
static bool	compare_azimuth (Planewave const &i, Planewave const &j) hoa_noexcept
	Compares the azimuth of two plane waves.

Detailed Description

template<Dimension D, typename T>
class hoa::Planewave< D, T >

The class owns basic plane waves informations.

The class allows to retrieves several informations about the plane waves: the the polar coordinates, azimuth and the elevation and cartesian coodinates, abscissa, the ordinate and the height.

Definition at line 25 of file Hoa_Planewaves.hpp.

Constructor & Destructor Documentation

Planewave ( size_t  index, T  azimuth, T  elevation  )

inline

The plane wave polar constructor.

Parameters

index	The index must be at least 1.
azimuth	The azimuth \(\theta\).
elevation	The elevation \(\varphi\).

Definition at line 33 of file Hoa_Planewaves.hpp.

Planewave ( size_t  index, T  abscissa, T  ordinate, T  height  )

inline

The plane wave cartesian constructor.

Parameters

index	The index must be at least 1.
abscissa	The abscissa \(x\).
ordinate	The ordinate \(y\).
height	The height \(z\).

Definition at line 41 of file Hoa_Planewaves.hpp.

Member Function Documentation

void setAzimuth ( const T  azimuth )

inline

Sets the azimuth of the plane wave.

Parameters

azimuth

The azimuth \(\theta\).

Definition at line 67 of file Hoa_Planewaves.hpp.

void setElevation ( const T  elevation )

inline

Set the elevation of the plane wave.

Parameters

elevation

The elevation \(\varphi\).

Definition at line 71 of file Hoa_Planewaves.hpp.