rise::antenna::Antenna Class Reference

Base class of all antennas.

#include <antenna/Antenna.hpp>

Inheritance diagram for rise::antenna::Antenna:

[legend]

Collaboration diagram for rise::antenna::Antenna:

[legend]

List of all members.

Public Member Functions
	Antenna (const wns::pyconfig::View &pyConfigView, Station *const station)
	Constructor setting characteristicType, position, and rotation axis.
	Antenna ()
	Antenna class for base and mobile stations.
virtual wns::Ratio	getGain (const wns::Position &pos, const PatternPtr pattern) const =0
const wns::Position &	getPosition () const
Station *	getStation () const
void	positionChanged ()
void	positionWillChange ()
virtual	~Antenna ()
Protected Member Functions
virtual void	drawRadiationPattern () const
	method that writes the pattern to a file
Protected Attributes
bool	drawPattern
	flag that stores whether to draw antenna pattern
RISELogger	log
	Local Logger.
std::string	patternOutputFile
	Pattern files are written here.
double	radius
Private Member Functions
void	preparePatternOutputFile ()
	Truncate/create the pattern files.
Private Attributes
unsigned long int	id
	Antenna ID of this antenna.
wns::PositionOffset	pd_positionOffset
	The offset from the base point of the Station (pd_station).
Station *	pd_station
	The Station the Antenna is mounted to.
wns::Position	position
	The Position current position of the antenna.
Static Private Attributes
static unsigned long int	counter = 0
	Counter of antenna ids.
static std::set< std::string >	patternOutputFilePrepared = std::set<std::string>()

---

Detailed Description

Definition at line 61 of file Antenna.hpp.

---

Constructor & Destructor Documentation

Antenna::Antenna

(

)

Omnidirectional and directional antenna patterns with different beamwidth are provided internally. There is also support for reading antenna patterns from files in 3d and planet format.

Definition at line 37 of file Antenna.cpp.

Antenna::Antenna	(	const wns::pyconfig::View &	pyConfigView,
		Station *const	station
	)

Constructor setting antenna characteristic, position offset relative to the station it belongs to, and rotation axis direction.

Definition at line 50 of file Antenna.cpp.

Antenna::~Antenna

(

)

[virtual]

Definition at line 91 of file Antenna.cpp.

---

Member Function Documentation

void Antenna::drawRadiationPattern

(

)

const [protected, virtual]

Reimplemented in rise::antenna::Beamforming.

Definition at line 94 of file Antenna.cpp.

virtual wns::Ratio rise::antenna::Antenna::getGain	(	const wns::Position &	pos,
		const PatternPtr	pattern
	)			const [pure virtual]

Implemented in rise::antenna::Beamforming, rise::antenna::ITUAntenna, rise::antenna::ITUAntennaWithWrap, and rise::antenna::Static.

const wns::Position& rise::antenna::Antenna::getPosition

(

)

const [inline]

Definition at line 88 of file Antenna.hpp.

rise::Station * Antenna::getStation

(

)

const

Definition at line 130 of file Antenna.cpp.

void Antenna::positionChanged

(

)

[virtual]

Implements wns::PositionObserver.

Definition at line 135 of file Antenna.cpp.

void rise::antenna::Antenna::positionWillChange

(

)

[inline, virtual]

Implements wns::PositionObserver.

Definition at line 95 of file Antenna.hpp.

void Antenna::preparePatternOutputFile

(

)

[private]

Definition at line 140 of file Antenna.cpp.

---

Member Data Documentation

unsigned long int Antenna::counter = 0 [static, private]

Definition at line 151 of file Antenna.hpp.

bool rise::antenna::Antenna::drawPattern [protected]

Definition at line 110 of file Antenna.hpp.

unsigned long int rise::antenna::Antenna::id [private]

Definition at line 146 of file Antenna.hpp.

RISELogger rise::antenna::Antenna::log [protected]

Definition at line 105 of file Antenna.hpp.

std::string rise::antenna::Antenna::patternOutputFile [protected]

Definition at line 118 of file Antenna.hpp.

std::set< std::string > Antenna::patternOutputFilePrepared = std::set<std::string>() [static, private]

Definition at line 153 of file Antenna.hpp.

wns::PositionOffset rise::antenna::Antenna::pd_positionOffset [private]

Definition at line 134 of file Antenna.hpp.

Station* rise::antenna::Antenna::pd_station [private]

Definition at line 129 of file Antenna.hpp.

wns::Position rise::antenna::Antenna::position [private]

recomputed when the station moves

Definition at line 141 of file Antenna.hpp.

double rise::antenna::Antenna::radius [protected]

Definition at line 107 of file Antenna.hpp.

---

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

• framework/rise/src/antenna/Antenna.hpp
• framework/rise/src/antenna/Antenna.cpp