NMPB08 Shared Libraries
Public Member Functions | Public Attributes
PropagationPath Struct Reference

Structure for the propagation path. More...

#include <PathStructures.h>

List of all members.

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.
ProfilePointNMPBGetSource ()
 Gets Source.
ProfilePointNMPBGetReceiver ()
 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

Detailed Description

Structure for the propagation path.

Definition at line 164 of file PathStructures.h.


Constructor & Destructor Documentation

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.


Member Function Documentation

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

Parameters:
point3DThe 3D coordinates
gThe 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.

Parameters:
point3DThe 3D coordinates
gThe ground impedance before the point
extThe extension data

Definition at line 247 of file PathStructures.h.

double const* PropagationPath::GetFrequencies ( ) [inline]

Gets frequencies.

Returns:
the frequencies array

Definition at line 415 of file PathStructures.h.

int PropagationPath::GetFrequencyPosition ( double  freq) [inline]

Search a frequency in the frequencies array.

Parameters:
freqThe searched frequency
Returns:
the frequency position in the array (-1 if not found)

Definition at line 434 of file PathStructures.h.

int PropagationPath::GetNbFrequencies ( ) [inline]

Gets frequencies number.

Returns:
the number of frequencies

Definition at line 405 of file PathStructures.h.

bool PropagationPath::GetOption ( Option  option) [inline]

Get the value of the option.

Parameters:
optionThe option to check
Returns:
true if the option is selected

Definition at line 475 of file PathStructures.h.

ProfilePointNMPB* PropagationPath::GetReceiver ( ) [inline]

Gets Receiver.

Returns:
the receiver

Definition at line 371 of file PathStructures.h.

ProfilePointNMPB* PropagationPath::GetSource ( ) [inline]

Gets Source.

Returns:
the source

Definition at line 356 of file PathStructures.h.

void PropagationPath::SetFrequencies ( int  nbFreq,
double const *  freq 
) [inline]

Set frequencies.

Parameters:
nbFreqThe frequencies number
freqThe 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.

Parameters:
optionThe option to set
on_offTrue 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.

Parameters:
hThe receiver height
Returns:
true if all OK
Exceptions:
ERRNoPoint

Definition at line 335 of file PathStructures.h.

bool PropagationPath::SetSourceHeight ( double  h) [inline]

Sets source height.

Parameters:
hThe source height
Returns:
true if all OK
Exceptions:
ERRNoPoint

Definition at line 310 of file PathStructures.h.


Member Data Documentation

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.

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.


The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines