antenna::DipoleAntenna Class Reference

Class that represents a dipole antenna. More...

#include <dipole.h>

Inheritance diagram for antenna::DipoleAntenna:

Public Member Functions
	DipoleAntenna (uint8_t type, double frequency, int polarization, double pointing_error)
	The constructor of dipole_antenna class.
double	get_gain ()
	Get the gain of the dipole antenna. This is the implementation of the parent's pure virtual function for the helix antenna.
double	get_gain_rolloff ()
	Get the the gain roll-off of the antenna.
double	get_beamwidth ()
	Get the beamwidth of the dipole antenna. This is the implementation of the parent's pure virtual function for the dipole antenna.
Public Member Functions inherited from antenna::GenericAntenna
int	unique_id ()
double	get_frequency ()
	Get the frequency of the antenna.
void	set_pointing_error (double error)
	Set the pointing error of the antenna.
double	get_pointing_error ()
	Get the pointing error of the antenna.
int	get_polarization ()
	Get the polarization of the antenna.
double	get_wavelength ()
	Get the wavelength of the antenna.
	GenericAntenna (uint8_t type, double frequency, int polarization, double pointing_error)
	The constructor of generic_antenna class.

Additional Inherited Members
Public Types inherited from antenna::GenericAntenna
enum	antenna_t {   YAGI , HELIX , PARABOLIC_REFLECTOR , CANTED_TURNSTYLE ,   CUSTOM , MONOPOLE , DIPOLE , QUADRIFILAR_HELIX }
Public Attributes inherited from antenna::GenericAntenna
uint8_t	d_type
double	d_frequency
double	d_pointing_error
int	d_polarization
int	my_id
Static Public Attributes inherited from antenna::GenericAntenna
static int	base_unique_id = 1

Detailed Description

Class that represents a dipole antenna.

The dipole_antenna class extends the generic_antenna class to simulate the behavior of a dipole antenna.

Constructor & Destructor Documentation

DipoleAntenna()

antenna::DipoleAntenna::DipoleAntenna	(	uint8_t	type,
		double	frequency,
		int	polarization,
		double	pointing_error )

The constructor of dipole_antenna class.

Parameters

type	The enumeration that defines the type of the antenna
frequency	The frequency of the antenna in Hz
polarization	The enumeration that defines the antenna polarization
pointing_error	The pointing error of the antenna in degrees.

Member Function Documentation

get_beamwidth()

double antenna::DipoleAntenna::get_beamwidth ( )

virtual

Get the beamwidth of the dipole antenna. This is the implementation of the parent's pure virtual function for the dipole antenna.

Returns

the beamwidth.

Implements antenna::GenericAntenna.

get_gain()

double antenna::DipoleAntenna::get_gain ( )

virtual

Get the gain of the dipole antenna. This is the implementation of the parent's pure virtual function for the helix antenna.

Returns

the gain in dBiC.

Implements antenna::GenericAntenna.

get_gain_rolloff()

double antenna::DipoleAntenna::get_gain_rolloff ( )

virtual

Get the the gain roll-off of the antenna.

Returns

the gain roll-off in dB.

Implements antenna::GenericAntenna.

---

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

• src-core/dsp/channel_model/model/antenna/dipole.h
• src-core/dsp/channel_model/model/antenna/dipole.cpp