ns3::Angles Struct Reference

struct holding the azimuth and inclination angles of spherical coordinates. More...

#include "angles.h"

Public Member Functions
	Angles ()
	default constructor, will initialize phi and theta to zero More...
	Angles (double phi, double theta)
	this constructor allows to specify phi and theta More...
	Angles (Vector v)
	this constructor will initialize phi and theta by converting the given 3D vector from cartesian coordinates to spherical coordinates More...
	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 More...

Public Attributes
double	phi
	the azimuth angle in radians More...
double	theta
	the inclination angle in radians More...

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
     +-------->
    /  \|
   /___/
x /  phi
 |/

Definition at line 71 of file angles.h.

Constructor & Destructor Documentation

Angles() [1/4]

ns3::Angles::Angles

(

)

default constructor, will initialize phi and theta to zero

Definition at line 60 of file angles.cc.

Angles() [2/4]

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

this constructor allows to specify phi and theta

Parameters

phi	the azimuth angle in radians
theta	the inclination angle in radians

Definition at line 67 of file angles.cc.

Angles() [3/4]

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

v	the 3D vector in cartesian coordinates

Definition at line 74 of file angles.cc.

Angles() [4/4]

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

v	the point (in cartesian coordinates) for which the angles are determined
o	the origin (in cartesian coordinates) of the spherical coordinate system

Definition at line 80 of file angles.cc.

Member Data Documentation

phi

double ns3::Angles::phi

the azimuth angle in radians

Definition at line 111 of file angles.h.

Referenced by IsotropicAntennaModelTestCase::BuildNameString(), CosineAntennaModelTestCase::BuildNameString(), ParabolicAntennaModelTestCase::BuildNameString(), OneVectorConstructorTestCase::DoRun(), TwoVectorsConstructorTestCase::DoRun(), ns3::CosineAntennaModel::GetGainDb(), ns3::ParabolicAntennaModel::GetGainDb(), ns3::operator<<(), and ns3::operator>>().

theta

double ns3::Angles::theta

the inclination angle in radians

Definition at line 117 of file angles.h.

Referenced by IsotropicAntennaModelTestCase::BuildNameString(), ParabolicAntennaModelTestCase::BuildNameString(), CosineAntennaModelTestCase::BuildNameString(), OneVectorConstructorTestCase::DoRun(), TwoVectorsConstructorTestCase::DoRun(), ns3::operator<<(), and ns3::operator>>().

---

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

• src/antenna/model/angles.h
• src/antenna/model/angles.cc