ns-3
Public Member Functions | Public Attributes
ns3::Angles Struct Reference

#include <angles.h>

List of all members.

Public Member Functions

 Angles ()
 Angles (double phi, double theta)
 Angles (Vector v)
 Angles (Vector v, Vector o)

Public Attributes

double phi
double theta

Detailed Description

struct holding the azimuth and inclination angles of spherical coordinates. The notation is the one used in "Antenna Theory - Analysis and Design", C.A. Balanis, Wiley, 2nd Ed., section 2.2 "Radiation pattern". This notation corresponds to the standard spherical coordinates, with phi measured counterclockwise in the x-y plane off the x-axis, and theta measured off the z-axis. 

     ^
   z | 
     |_ theta
     | \
     | /|
     |/ |   y
     +&mdash;&mdash;&ndash;>
    /  \|
   /___/
x /  phi
 |/

Constructor & Destructor Documentation

ns3::Angles::Angles ( )

default constructor, will initialize phi and theta to zero

ns3::Angles::Angles ( double  phi,
double  theta 
)

this constructor allows to specify phi and theta

Parameters:
phithe azimuth angle in radians
thetathe inclination angle in radians
ns3::Angles::Angles ( Vector  v)

this constructor will initialize phi and theta by converting the given 3D vector from cartesian coordinates to spherical coordinates

Parameters:
vthe 3D vector in cartesian coordinates
ns3::Angles::Angles ( Vector  v,
Vector  o 
)

this constructor initializes an Angles instance with the angles of the spherical coordinates of point v respect to point o

Parameters:
vthe point (in cartesian coordinates) for which the angles are determined
othe origin (in cartesian coordinates) of the spherical coordinate system

Member Data Documentation

double ns3::Angles::phi

the azimuth angle in radians

Referenced by ns3::CosineAntennaModel::GetGainDb(), ns3::ParabolicAntennaModel::GetGainDb(), ns3::operator<<(), and ns3::operator>>().

double ns3::Angles::theta

the inclination angle in radians

Referenced by ns3::operator<<(), and ns3::operator>>().

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