INET Framework for OMNeT++/OMNEST
inet::physicallayer::IAntenna Class Referenceabstract

This interface represents a physical device (a part of the radio) which converts electric signals into radio waves, and vice versa. More...

#include <IAntenna.h>

Inheritance diagram for inet::physicallayer::IAntenna:
inet::physicallayer::IPrintableObject inet::physicallayer::AntennaBase inet::physicallayer::ConstantGainAntenna inet::physicallayer::CosineAntenna inet::physicallayer::DipoleAntenna inet::physicallayer::InterpolatingAntenna inet::physicallayer::IsotropicAntenna inet::physicallayer::ParabolicAntenna

Public Member Functions

virtual IMobilitygetMobility () const =0
 Returns the mobility of this antenna that describes its position and orientation over time. More...
 
virtual int getNumAntennas () const =0
 Returns the number of antennas in the array. More...
 
virtual double getMaxGain () const =0
 Returns the maximum possible antenna gain independent of any direction. More...
 
virtual double computeGain (const EulerAngles direction) const =0
 Returns the antenna gain in the provided direction. More...
 
- Public Member Functions inherited from inet::physicallayer::IPrintableObject
virtual ~IPrintableObject ()
 
virtual std::ostream & printToStream (std::ostream &stream, int level) const
 Prints this object to the provided output stream. More...
 
virtual std::string getInfoStringRepresentation () const
 
virtual std::string getDetailStringRepresentation () const
 
virtual std::string getDebugStringRepresentation () const
 
virtual std::string getTraceStringRepresentation () const
 
virtual std::string getCompleteStringRepresentation () const
 

Additional Inherited Members

- Public Types inherited from inet::physicallayer::IPrintableObject
enum  PrintLevel {
  PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO,
  PRINT_LEVEL_COMPLETE = INT_MIN
}
 

Detailed Description

This interface represents a physical device (a part of the radio) which converts electric signals into radio waves, and vice versa.

Member Function Documentation

virtual double inet::physicallayer::IAntenna::computeGain ( const EulerAngles  direction) const
pure virtual

Returns the antenna gain in the provided direction.

The direction is relative to the antenna geometry, so the result depends only on the antenna characteristics. For transmissions, it determines how well the antenna converts input power into radio waves headed in the specified direction. For receptions, it determines how well the antenna converts radio waves arriving from the the specified direction.

Implemented in inet::physicallayer::InterpolatingAntenna, inet::physicallayer::ParabolicAntenna, inet::physicallayer::CosineAntenna, inet::physicallayer::DipoleAntenna, inet::physicallayer::ConstantGainAntenna, and inet::physicallayer::IsotropicAntenna.

Referenced by inet::physicallayer::ScalarAnalogModelBase::computeReceptionPower(), and inet::physicallayer::DimensionalAnalogModelBase::computeReceptionPower().

virtual double inet::physicallayer::IAntenna::getMaxGain ( ) const
pure virtual
virtual int inet::physicallayer::IAntenna::getNumAntennas ( ) const
pure virtual

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