Defines and constants

Detailed Description

Wave propagation interface defines.

Definition of Legend palettes.
LEGEND_PALETTE_MAXIMUM_REGULAR 1536
Size of regular legend palette.
LEGEND_PALETTE_MAXIMUM_PROMAN 1280
Size of legend palette in ProMan.
Definition of simulation scenarios.
WINPROP_SCENARIO_URBAN 0
Urban scenario. This is used in WinProp_Scenario::Scenario.
WINPROP_SCENARIO_INDOOR 1
Indoor scenario. This is used in WinProp_Scenario::Scenario.
WINPROP_SCENARIO_RURAL 2
Rural scenario. This is used in WinProp_Scenario::Scenario.
Selection of simulation models.
WINPROP_MODEL_FREESPACE 0
Free space model. See Model_FREESPACE.
WINPROP_MODEL_COST231 1
COST 231 model. See Model_COST.
WINPROP_MODEL_DPM 2
Dominant path model. See Model_DPM.
WINPROP_MODEL_IRT 3
Intelligent ray tracing model. See Model_RAYTRACING.
WINPROP_MODEL_SRT 4
Standard ray tracing model. See Model_RAYTRACING.
WINPROP_MODEL_VRT 5
Vertical ray tracing model. See Model_VRT.
WINPROP_MODEL_SBR 6
Shooting & bouncing rays model. See Model_RAYTRACING.
WINPROP_MODEL_MOTLEYKEENAN 7
Motley-Keenan model. See Model_MOTLEYKEENAN.
Types of results returned by the propagation API.
PROP_RESULT_UNKNOWN -1
Unknown result type.
PROP_RESULT_POWER 0
Received power.
PROP_RESULT_FIELD 1
Field strength.
PROP_RESULT_PATHLOSS 2
Path loss.
PROP_RESULT_DELAY 3
Delay.
PROP_RESULT_PATHTYPE 4
Type of path: LOS, OLOS, NLOS, unknown path. See WinProp_Result::DataType.
Path type definitions
PROP_RESULT_PATHTYPE_UNKNOWN -1
Unknown path type.
PROP_RESULT_PATHTYPE_LOS 0
Line of sight (LOS) path.
PROP_RESULT_PATHTYPE_OLOS 1
Obstructed line of sight (OLOS) path.
PROP_RESULT_PATHTYPE_NLOS 2
Non-line of sight (NLOS) path.
Power definition for antenna
WINPROP_POWER_OUTPUT 0
Output power amplifier.
WINPROP_POWER_EIRP 1
EIRP.
WINPROP_POWER_ERP 2
ERP.
Type definition for antenna
WINPROP_ANTENNA_ORDINARY 0
Ordinary antenna. This is used in WinProp_Antenna::Type.
WINPROP_ANTENNA_RADIATING_CABLE 1
Radiating cable. This is used in WinProp_Antenna::Type.
WINPROP_ANTENNA_SATELLITE 2
Satellite (Geostationary and Non-stationary). This is used in WinProp_Antenna::Type.
WINPROP_ANTENNA_GPS_SATELLITE 3
GPS Satellite (Almanac and TLE). This is used in WinProp_Antenna::Type.
WINPROP_ANTENNA_EXTERNAL 4
External leakage interference. This is used in WinProp_Antenna::Type.
Definition of interaction model along a path
WINPROP_INTERACTION_MODEL_EMPIRICAL 0
Empirical losses for reflection, transmission and diffraction.
WINPROP_INTERACTION_MODEL_GTDUTD 1
Fresnel coefficients for reflection and transmission, and GTD/UTD for diffraction.
Definition of the size of the antenna pattern loaded from RAM
WINPROP_SIZE_PATTERN_VERTICAL 180
Number of samples in the vertical cut of the pattern loaded from RAM (See the setting in WinProp_Pattern::Mode)
WINPROP_SIZE_PATTERN_HORIZONTAL 360
Number of samples in the horizontal cut of the pattern loaded from RAM (See the setting in WinProp_Pattern::Mode)
Error message length
MAX_ERROR_LEN 300
Maximum length of the error message string.
Definition of prediction models for radiating cables
WINPROP_MODEL_ID_CABLE_SDM 1
Shortest distance model.
WINPROP_MODEL_ID_CABLE_STL 2
Smallest transmission loss model.
WINPROP_MODEL_ID_CABLE_SPL 3
Smallest path loss model.
WINPROP_MODEL_ID_CABLE_DPM 4
Dominant path model.
Selection of breakpoint mode.
BREAKPOINT_DISABLE -1
Disable breakpoint effect. See WinProp_Additional::BreakpointMode where this is used. Relevant for Standard ray tracing model.
BREAKPOINT_DEFAULT 0
Default determination of breakpoint. See WinProp_ParaMain::BreakpointMode and WinProp_Additional::BreakpointMode where this is used.
BREAKPOINT_FIXED 1
Breakpoint with fixed distance. See WinProp_ParaMain::BreakpointMode and WinProp_Additional::BreakpointMode where this is used.
BREAKPOINT_MEAN_BUILDING 2
Breakpoint computed with transmitter height relative to mean building height in a radiu of 1000m around it. See WinProp_ParaMain::BreakpointMode where this is used.
Type of prediction planes.
WINPROP_PRED_PLANE_TYPE_AREA_ABSOLUTE -2
Result corresponds to area prediction at absolute height.
WINPROP_PRED_PLANE_TYPE_AREA_RELATIVE -1
Result corresponds to area prediction at relative height.
WINPROP_PRED_PLANE_TYPE_PLANE 0
Result corresponds to a user specified prediction plane (either via parameters or from the database)
WINPROP_PRED_PLANE_TYPE_SURFACE 1
Result corresponds to a predicted surface of a database object.
WINPROP_PRED_PLANE_TYPE_HORIZONTAL 2
Result corresponds to a horizontal prediction, in urban scenarios to CNP layers.
WINPROP_PRED_PLANE_TYPE_VERTICAL 3
Result corresponds to a vertical prediction.
Enum
WINPROP_PATTERN_RESOLUTION
  • WINPROP_PATTERN_RESOLUTION_1DEG : 1.00 degrees pattern resolution
  • WINPROP_PATTERN_RESOLUTION_05DEG : 0.50 degrees pattern resolution
  • WINPROP_PATTERN_RESOLUTION_033DEG : 0.33 degrees pattern resolution
  • WINPROP_PATTERN_RESOLUTION_025DEG : 0.25 degrees pattern resolution
  • WINPROP_PATTERN_RESOLUTION_020DEG : 0.20 degrees pattern resolution
  • WINPROP_PATTERN_RESOLUTION_01DEG : 0.10 degrees pattern resolution
Other defines
ANTENNA_DISABLED 0
Antenna disabled.
ANTENNA_ENABLED 1
Antenna enabled.
ANTENNA_ENABLED_FIXED 2
Antenna enabled at a fixed site.
REPEATER_MODE_OFF 0
Antenna repeater mode is OFF.
REPEATER_MODE_RECONFIGURABLE 1
Antenna repeater is in reconfigurable mode.
REPEATER_MODE_TRANSPARENT 2
Antenna repeater is in transparent mode.
ANTENNA_POLARIZATION_MODE_UNKNOWN -1
Antenna polarisation unknown.
ANTENNA_POLARIZATION_MODE_LINEAR_VERTICAL 0
Antenna polarisation linear vertical.
ANTENNA_POLARIZATION_MODE_LINEAR_HORIZONTAL 1
Antenna polarisation linear horizontal.
ANTENNA_POLARIZATION_MODE_LINEAR_PLUS_45 2
Antenna polarisation linear +45 deg.
ANTENNA_POLARIZATION_MODE_LINEAR_MINUS_45 3
Antenna polarisation linear -45 deg.
ANTENNA_POLARIZATION_MODE_LINEAR_ARBITRARY 4
Antenna polarisation linear user defined.
ANTENNA_POLARIZATION_MODE_RHCP 5
Antenna polarisation right hand circular.
ANTENNA_POLARIZATION_MODE_LHCP 6
Antenna polarisation left hand circular.
PATTERN_MODE_2X2D 0
Total pattern given by 2 2-D patterns (vertical and horizontal polarisations). See WinProp_Pattern::Mode.
PATTERN_MODE_3D 1
Total pattern given by a 3-D pattern. See WinProp_Pattern::Mode.
PATTERN_MODE_FILE 2
Total pattern read from a file. See WinProp_Pattern::Mode.
WALL_STANDARD 0
WALL_VEGETATION 2
WALL_COURTYARD 3
The documentation was generated from the following file:
  • source.eng/Interface/WP_Antenna.h