NMPB08 Shared Libraries
|
Structure for the propagation path. More...
#include <PathStructures.h>
Public Member Functions | |
PropagationPath (void) | |
PropagationPath constructor. | |
~PropagationPath (void) | |
PropagationPath destructor. | |
void | ExtendPath (Position3D const *point3D, double g) |
adds a new terrain item to the terrainItems list | |
void | ExtendPathExt (Position3D const *point3D, double g, ExtensionNMPB const *ext) |
Adds a new terrain item to the terrainItems list, with extension data. | |
bool | SetSourceHeight (double h) |
Sets source height. | |
bool | SetReceiverHeight (double h) |
Sets receiver height. | |
ProfilePointNMPB * | GetSource () |
Gets Source. | |
ProfilePointNMPB * | GetReceiver () |
Gets Receiver. | |
void | SetFrequencies (int nbFreq, double const *freq) |
Set frequencies. | |
int | GetNbFrequencies () |
Gets frequencies number. | |
double const * | GetFrequencies () |
Gets frequencies. | |
int | GetFrequencyPosition (double freq) |
Search a frequency in the frequencies array. | |
void | SetOption (Option option, bool on_off) |
Set an option for the path. | |
bool | GetOption (Option option) |
Get the value of the option. | |
void | ClearPath () |
Clears the path items list. | |
Public Attributes | |
vector< ProfilePointNMPB * > | pathPoints |
the terrain items list | |
double | distSR |
distance between S and R | |
vector< double > | frequencies |
the frequencies list | |
double * | favorableAttenuations |
the calculated favorable attenuations | |
double * | homogeneousAttenuations |
the calculated homogeneous attenuations |
Structure for the propagation path.
Definition at line 164 of file PathStructures.h.
PropagationPath::PropagationPath | ( | void | ) | [inline] |
PropagationPath constructor.
Definition at line 190 of file PathStructures.h.
PropagationPath::~PropagationPath | ( | void | ) | [inline] |
PropagationPath destructor.
Definition at line 203 of file PathStructures.h.
void PropagationPath::ClearPath | ( | ) | [inline] |
Clears the path items list.
Definition at line 483 of file PathStructures.h.
void PropagationPath::ExtendPath | ( | Position3D const * | point3D, |
double | g | ||
) | [inline] |
adds a new terrain item to the terrainItems list
point3D | The 3D coordinates |
g | The ground impedance before the point |
Definition at line 221 of file PathStructures.h.
void PropagationPath::ExtendPathExt | ( | Position3D const * | point3D, |
double | g, | ||
ExtensionNMPB const * | ext | ||
) | [inline] |
Adds a new terrain item to the terrainItems list, with extension data.
point3D | The 3D coordinates |
g | The ground impedance before the point |
ext | The extension data |
Definition at line 247 of file PathStructures.h.
double const* PropagationPath::GetFrequencies | ( | ) | [inline] |
int PropagationPath::GetFrequencyPosition | ( | double | freq | ) | [inline] |
Search a frequency in the frequencies array.
freq | The searched frequency |
Definition at line 434 of file PathStructures.h.
int PropagationPath::GetNbFrequencies | ( | ) | [inline] |
Gets frequencies number.
Definition at line 405 of file PathStructures.h.
bool PropagationPath::GetOption | ( | Option | option | ) | [inline] |
Get the value of the option.
option | The option to check |
Definition at line 475 of file PathStructures.h.
ProfilePointNMPB* PropagationPath::GetReceiver | ( | ) | [inline] |
ProfilePointNMPB* PropagationPath::GetSource | ( | ) | [inline] |
void PropagationPath::SetFrequencies | ( | int | nbFreq, |
double const * | freq | ||
) | [inline] |
Set frequencies.
nbFreq | The frequencies number |
freq | The frequencies array |
Definition at line 388 of file PathStructures.h.
void PropagationPath::SetOption | ( | Option | option, |
bool | on_off | ||
) | [inline] |
Set an option for the path.
option | The option to set |
on_off | True if the option must be set to true |
Definition at line 456 of file PathStructures.h.
bool PropagationPath::SetReceiverHeight | ( | double | h | ) | [inline] |
Sets receiver height.
h | The receiver height |
ERRNoPoint |
Definition at line 335 of file PathStructures.h.
bool PropagationPath::SetSourceHeight | ( | double | h | ) | [inline] |
Sets source height.
h | The source height |
ERRNoPoint |
Definition at line 310 of file PathStructures.h.
double PropagationPath::distSR |
distance between S and R
Definition at line 173 of file PathStructures.h.
the calculated favorable attenuations
Definition at line 181 of file PathStructures.h.
vector<double> PropagationPath::frequencies |
the frequencies list
Definition at line 177 of file PathStructures.h.
the calculated homogeneous attenuations
Definition at line 185 of file PathStructures.h.
the terrain items list
Definition at line 169 of file PathStructures.h.