NMPB08 Shared Libraries
Classes | Enumerations
pathdefNMPB.h File Reference

Definition of main enumerations and structures used in the call of the library functions. More...

Go to the source code of this file.

Classes

struct  ExtensionNMPB
 Extension for path elements. More...
struct  Position3D
 3D point coordinates More...
struct  Position2D
 2D point coordinates in the vertical plane containing Source and Receptor More...

Enumerations

enum  ErrorType {
  ERRNone = 0, ERRNullPath = 10, ERRNoPoint = 11, ERROnePoint = 12,
  ERRSideDiff = 13, ERREmbankment = 14, ERRMaxDistance = 15, ERRFrequency = 20,
  ERRAttCoeffFrequency = 21, ERRAngle = 30, ERRProbability = 40, ERRDivZero = 50,
  ERRSqrtNegative = 51, ERRScreenAbsorption = 60, ERRUnknown = 100
}
 Error types send by functions. More...
enum  Option {
  EXCLUDE_ADIV = 1 << 1, EXCLUDE_AATM = 1 << 2, TRACE_DETAILS = 1 << 3, CHECK_EMBANKMENT = 1 << 4,
  FORCE_CH_EQUAL_ONE = 1 << 5
}
 Options that can be chosen by user. More...
enum  ExtensionTypeNMPB {
  ETNone_NMPB = 0, ETScreen_NMPB = 1, ETReflection_NMPB = 2, ETSideDiffraction_NMPB = 3,
  ETPlatform_NMPB = 4, ETEmbankment_NMPB = 5, ETRoadSource_NMPB = 6
}
 extension type More...

Detailed Description

Definition of main enumerations and structures used in the call of the library functions.

Author:
CSTB
Version:
1.0

Definition in file pathdefNMPB.h.


Enumeration Type Documentation

enum ErrorType

Error types send by functions.

Enumerator:
ERRNone 

No error.

ERRNullPath 

The PathID path is null.

ERRNoPoint 

There is no point in the path.

ERROnePoint 

There is only one point in the path.

ERRSideDiff 

There are more than 2 side diffractions (ProfilePointNMPB with ext.type = ETSideDiffraction_NMPB) in the path.

ERREmbankment 

There are more than 1 embankment (ProfilePointNMPB with ext.type = ETEmbankment_NMPB) in the path.

ERRMaxDistance 

The propagation distance exceeds the maximum value of 2000m.

ERRFrequency 

The frequency equals 0.

ERRAttCoeffFrequency 

Frequency not found to get attenuation coefficient.

ERRAngle 

Angle not found in the array containing favorable conditions probabilities for the angles.

ERRProbability 

The probability is greater than 1.

ERRDivZero 

Division by zero.

ERRSqrtNegative 

Square root of negative number.

ERRScreenAbsorption 

The given screen absorption is greater than 1.

ERRUnknown 

None expected error.

Definition at line 15 of file pathdefNMPB.h.

extension type

Enumerator:
ETNone_NMPB 

No particular extension.

ETScreen_NMPB 

Screen extension : height must be filled.

ETReflection_NMPB 

Reflection extension : height and alphaArray must be filled.

ETSideDiffraction_NMPB 

Side diffraction extension : height must be filled.

ETPlatform_NMPB 

Platform extension.

ETEmbankment_NMPB 

Embankment extension : cosTheta must be filled.

ETRoadSource_NMPB 

Road source extension.

Definition at line 109 of file pathdefNMPB.h.

enum Option

Options that can be chosen by user.

Enumerator:
EXCLUDE_ADIV 

Don't calculate Adiv.

EXCLUDE_AATM 

Don't calculate Aatm.

TRACE_DETAILS 

Displays trace details on console.

CHECK_EMBANKMENT 

Check embankments on the path.

FORCE_CH_EQUAL_ONE 

Disable correction term for diffraction by low height obstacles, always use Ch = 1.

Definition at line 82 of file pathdefNMPB.h.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines