EMANE  1.0.1
Public Member Functions | List of all members
EMANE::Events::AntennaProfile Class Reference

Holds NEM Id, antenna profile Id, azimuth and elevation. More...

#include <antennaprofile.h>

Public Member Functions

 AntennaProfile ()
 
 AntennaProfile (NEMId nemId, AntennaProfileId antennaProfileId, double dAntennaAzimuthDegrees, double dAntennaElevationDegrees)
 
NEMId getNEMId () const
 
AntennaProfileId getAntennaProfileId () const
 
double getAntennaAzimuthDegrees () const
 
double getAntennaElevationDegrees () const
 
bool operator== (const AntennaProfile &rhs) const
 

Detailed Description

Holds NEM Id, antenna profile Id, azimuth and elevation.

Note
Instances are immutable

Definition at line 51 of file antennaprofile.h.

Constructor & Destructor Documentation

◆ AntennaProfile() [1/2]

EMANE::Events::AntennaProfile::AntennaProfile ( )
inline

Creates an AntennaProfile instance with a NEM Id, profile id azimuth and elevation of 0.

Definition at line 34 of file antennaprofile.inl.

◆ AntennaProfile() [2/2]

EMANE::Events::AntennaProfile::AntennaProfile ( NEMId  nemId,
AntennaProfileId  antennaProfileId,
double  dAntennaAzimuthDegrees,
double  dAntennaElevationDegrees 
)
inline

Creates an AntennaProfile instance

Parameters
nemIdId of NEM
antennaProfileIdAntenna profile id
dAntennaAzimuthDegreesAntenna azimuth in degrees
dAntennaElevationDegreesAntenna elevation in degrees

Definition at line 38 of file antennaprofile.inl.

Member Function Documentation

◆ getAntennaAzimuthDegrees()

double EMANE::Events::AntennaProfile::getAntennaAzimuthDegrees ( ) const
inline

Gets the antenna pointing azimuth in degrees

Returns
azimuth

Definition at line 61 of file antennaprofile.inl.

◆ getAntennaElevationDegrees()

double EMANE::Events::AntennaProfile::getAntennaElevationDegrees ( ) const
inline

Gets the antenna pointing elevation in degrees

Returns
elevation

Definition at line 67 of file antennaprofile.inl.

◆ getAntennaProfileId()

EMANE::AntennaProfileId EMANE::Events::AntennaProfile::getAntennaProfileId ( ) const
inline

Gets the antenna profile Id

Returns
profile Id

Definition at line 55 of file antennaprofile.inl.

◆ getNEMId()

EMANE::NEMId EMANE::Events::AntennaProfile::getNEMId ( ) const
inline

Gets the NEM Id

Returns
NEM Id

Definition at line 49 of file antennaprofile.inl.

◆ operator==()

bool EMANE::Events::AntennaProfile::operator== ( const AntennaProfile &  rhs) const
inline

Determines if another instance is equal

Returns
true if equal, false if not

Definition at line 73 of file antennaprofile.inl.

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