NMPB08 Shared Libraries
Public Member Functions | Protected Member Functions | Protected Attributes
GroundEffectNMPB::MeanPlane Class Reference

Class used to calculate the mean plane. More...

#include <GroundEffect.h>

List of all members.

Public Member Functions

 MeanPlane ()
 Initialization of the MeanPlane class.
 MeanPlane (vector< ProfilePointNMPB * > terrainItems)
 Initialization of the MeanPlane class with given arguments, and data calculation.
double Get_dp ()
 Gets distance between source and receiver on the mean plane.
double Get_zEqSource ()
 Gets Source equivalent height.
double Get_zEqReceiver ()
 Gets Receiver equivalent height.
double Get_Gpath ()
 Gets ground coefficient.
Position2D Get_sourceImage ()
 Gets the source image by the mean plane.
Position2D Get_receiverImage ()
 Gets the receiver image by the mean plane.
double Get_aCoeff ()
 Gets the "a" coefficient for the mean plane line equation z = ad + b.
double Get_bCoeff ()
 Gets the "b" coefficient for the mean plane line equation z = ad + b.
double Get_Gsource ()
 Gets the impedance source.

Protected Member Functions

void FillLineCoefficients ()
 Calculates the mean plane coefficients (a and b : z = ad + b)
Position2D MeanPlaneProjection (Position2D const *point)
 Calculates the mean plane projection of a point.
void FillData ()
 Calculates distance between source and receiver on the mean plane, S image, R image, S equivalent height, R equivalent height and the ground coefficient.
void CalculateData ()
 Calculates the mean plane coefficients and then the equivalent heights and the distance on the mean plane.

Protected Attributes

ProfilePointNMPB_source
 Source.
ProfilePointNMPB_receiver
 Receiver.
vector< ProfilePointNMPB * > _terrainItems
 terrain items
vector< Position2D_pointsList
 items coordinates list
double _aCoeff
 the mean plane a coefficient (a and b : z = ad + b)
double _bCoeff
 the mean plane b coefficient (a and b : z = ad + b)
double _dp
 distance between source and receiver on the mean plane
double _zEqS
 S equivalent height.
double _zEqR
 R equivalent height.
double _Gpath
 ground coefficient
Position2D _imageS
 source image by the mean plane
Position2D _imageR
 receiver image by the mean plane

Detailed Description

Class used to calculate the mean plane.

p. 69 - Annexe E

Definition at line 37 of file GroundEffect.h.


Constructor & Destructor Documentation

GroundEffectNMPB::MeanPlane::MeanPlane ( ) [inline]

Initialization of the MeanPlane class.

Definition at line 43 of file GroundEffect.h.

GroundEffectNMPB::MeanPlane::MeanPlane ( vector< ProfilePointNMPB * >  terrainItems)

Initialization of the MeanPlane class with given arguments, and data calculation.

Parameters:
terrainItemsThe terrain item vector

Definition at line 21 of file GroundEffect.cpp.


Member Function Documentation

void GroundEffectNMPB::MeanPlane::CalculateData ( ) [inline, protected]

Calculates the mean plane coefficients and then the equivalent heights and the distance on the mean plane.

Definition at line 233 of file GroundEffect.h.

void GroundEffectNMPB::MeanPlane::FillData ( ) [protected]

Calculates distance between source and receiver on the mean plane, S image, R image, S equivalent height, R equivalent height and the ground coefficient.

p. 38 - § 9.3.1 ; p. 39 - § 9.3.2

Definition at line 109 of file GroundEffect.cpp.

void GroundEffectNMPB::MeanPlane::FillLineCoefficients ( ) [protected]

Calculates the mean plane coefficients (a and b : z = ad + b)

p. 69 - Annexe E

Definition at line 49 of file GroundEffect.cpp.

double GroundEffectNMPB::MeanPlane::Get_aCoeff ( ) [inline]

Gets the "a" coefficient for the mean plane line equation z = ad + b.

Returns:
the "a" coefficient for the mean plane line equation z = ad + b

Definition at line 125 of file GroundEffect.h.

double GroundEffectNMPB::MeanPlane::Get_bCoeff ( ) [inline]

Gets the "b" coefficient for the mean plane line equation z = ad + b.

Returns:
the "b" coefficient for the mean plane line equation z = ad + b

Definition at line 135 of file GroundEffect.h.

double GroundEffectNMPB::MeanPlane::Get_dp ( ) [inline]

Gets distance between source and receiver on the mean plane.

Returns:
the distance between source and receiver on the mean plane

Definition at line 65 of file GroundEffect.h.

double GroundEffectNMPB::MeanPlane::Get_Gpath ( ) [inline]

Gets ground coefficient.

Returns:
the ground coefficient

Definition at line 95 of file GroundEffect.h.

double GroundEffectNMPB::MeanPlane::Get_Gsource ( ) [inline]

Gets the impedance source.

Returns:
the impedance source

Definition at line 145 of file GroundEffect.h.

Position2D GroundEffectNMPB::MeanPlane::Get_receiverImage ( ) [inline]

Gets the receiver image by the mean plane.

Returns:
the receiver image by the mean plane

Definition at line 115 of file GroundEffect.h.

Position2D GroundEffectNMPB::MeanPlane::Get_sourceImage ( ) [inline]

Gets the source image by the mean plane.

Returns:
the source image by the mean plane

Definition at line 105 of file GroundEffect.h.

double GroundEffectNMPB::MeanPlane::Get_zEqReceiver ( ) [inline]

Gets Receiver equivalent height.

Returns:
the Receiver equivalent height

Definition at line 85 of file GroundEffect.h.

double GroundEffectNMPB::MeanPlane::Get_zEqSource ( ) [inline]

Gets Source equivalent height.

Returns:
the Source equivalent height

Definition at line 75 of file GroundEffect.h.

Position2D GroundEffectNMPB::MeanPlane::MeanPlaneProjection ( Position2D const *  point) [protected]

Calculates the mean plane projection of a point.

Parameters:
pointThe 2D point to be projected
Returns:
The projected 2D point

Definition at line 93 of file GroundEffect.cpp.


Member Data Documentation

the mean plane a coefficient (a and b : z = ad + b)

Definition at line 175 of file GroundEffect.h.

the mean plane b coefficient (a and b : z = ad + b)

Definition at line 179 of file GroundEffect.h.

distance between source and receiver on the mean plane

Definition at line 183 of file GroundEffect.h.

ground coefficient

Definition at line 195 of file GroundEffect.h.

receiver image by the mean plane

Definition at line 203 of file GroundEffect.h.

source image by the mean plane

Definition at line 199 of file GroundEffect.h.

items coordinates list

Definition at line 171 of file GroundEffect.h.

Receiver.

Definition at line 163 of file GroundEffect.h.

Source.

Definition at line 159 of file GroundEffect.h.

terrain items

Definition at line 167 of file GroundEffect.h.

R equivalent height.

Definition at line 191 of file GroundEffect.h.

S equivalent height.

Definition at line 187 of file GroundEffect.h.


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