WinProp_ParaMain
Data Fields
- WINPROP_OUTDOOR_SCENARIO_MODE
- ScenarioMode
- PREDMODEL_URBAN
- PredictionModelUrban
- PREDMODEL_RURAL
- PredictionModelRural
- unsigned int
- PredictionLargeArea
- double
- UrbanLowerLeftX
- double
- UrbanLowerLeftY
- double
- UrbanUpperRightX
- double
- UrbanUpperRightY
- double
- RuralLowerLeftX
- double
- RuralLowerLeftY
- double
- RuralUpperRightX
- double
- RuralUpperRightY
- double
- Resolution
- int
- NrLayers
- double *
- PredictionHeights
- int
- NrTimeInstances
- double *
- TimeInstances
- int
- AbsolutePredictionHeight
- double
- VectorRadius
- WINPROP_BREAKPOINT_MODE
- BreakpointMode
- double
- BreakpointFactor
- double
- BreakpointOffset
- double
- BreakpointDistance
- WINPROP_BUILDINGS_MODE
- BuildingsMode
- double
- BuildingHeights
- int
- BuildingHeightsAbs
- int
- BuildingsMaterialsInd
- double
- BuildingsTransmissionLoss
- URBAN_BUILDINGS
- Buildings
- WinProp_Filename
- BuildingsName
- WINPROP_INDOOR_COVERAGE_MODE
- BuildingsIndoorCoverage
- WINPROP_OUTDOOR_TOPO_MODE
- TopographyMode
- TOPOGRAPHY
- Topography
- WinProp_Filename
- TopographyName
- bool
- TopographyIndexDatabase
- int
- TopographyHeightMode
- WINPROP_CLUTTER_MODE
- ClutterMode
- WINPROP_CLUTTER_HEIGHT_MODE
- ClutterConsideration
- WINPROP_CLUTTER_ATTENUATION_MODE
- ClutterAttenuation
- int
- ClutterIntervalsNumber
- float
- ClutterIntervalsLength
- int
- ClutterCalibration
- CLUTTER
- Clutter
- WinProp_Filename
- ClutterName
- bool
- ClutterIndexDatabase
- WinProp_Filename
- ClutterClassesName
- WINPROP_VEGETATION_MODE
- VegetationMode
- WinProp_Filename
- VegetationName
- int
- VegetationPropertiesInd
- double
- VegetationLossFixed
- double
- VegetationLossPerMeter
- double
- VegetationResolution
- unsigned int
- BuildingsPixelMode
- TOPOGRAPHY
- BuildingsPixel
- WinProp_Filename
- BuildingsPixelName
- int
- BuildingsPixelHeightMode
- double
- BuildingsPixelHeightTolerance
- int
- ConsiderDatabasePolygons
- int
- NrDatabasePolygons
- WinProp_Polygon *
- DatabasePolygons
- WinProp_Additional_Freq_Loss
- FreqDepLosses
- WinProp_Propagation_Results *
- OutputResults
- double
- Offset
- unsigned int
- DistributedPrediction
- unsigned int
- Filter
- unsigned int
- FilterOrder
- unsigned int
- FilterMode
- bool
- UseAntennaLimit
- double
- AntennaLimit
- WinProp_ErrorString
- ErrorMessageMain
- WinProp_ErrorString
- ErrorMessageSub
- int
- SupressMessageBoxes
- int
- ModeAPI
- int
- MaxPathLossEnabled
- float
- MaxPathLoss
- int
- MaxDynamicPathsEnabled
- float
- MaxDynamicPaths
- int
- MaxNumberPathsUsed
- int
- MaxNumberPaths
- int
- RaysLogLin
- int
- RaysPowerField
- int
- IndoorPredictionOnly
- double
- ValueNotComputed
- double
- BuildingsIndoorDecrease
- int
- MultiThreading
- int
- FullPolarimetric
- int
- RuralModeCNP
- int
- PredictionSurfaces
Detailed Description
WinProp_ParaMain: Structure for urban parameters for outdoor plug-in. This structure is used to define most of the parameters for a prediction computation accomplished with the OutdoorPlugIn_ComputePrediction function.
Field Documentation
- ScenarioMode
-
- WINPROP_OUTDOOR_SCENARIO_MODE WinProp_ParaMain::ScenarioMode
- The scenario mode.
- PredictionModelUrban
-
- PREDMODEL_URBAN WinProp_ParaMain::PredictionModelUrban
- Selection of urban prediction model see PREDMODEL_URBAN. Only relevant for SCENARIOMODE_URBAN. See ScenarioMode.
- PredictionModelRural
-
- PREDMODEL_RURAL WinProp_ParaMain::PredictionModelRural
- Selection of rural prediction model see PREDMODEL_RURAL. Only relevant for SCENARIOMODE_RURAL. See ScenarioMode.
- PredictionLargeArea
-
- unsigned int WinProp_ParaMain::PredictionLargeArea
- Use large area mode (multi scenario)
- UrbanLowerLeftX
-
- double WinProp_ParaMain::UrbanLowerLeftX
- Lower left corner of urban prediction area (x coordinate).
- UrbanLowerLeftY
-
- double WinProp_ParaMain::UrbanLowerLeftY
- Lower left corner of urban prediction area (y coordinate).
- UrbanUpperRightX
-
- double WinProp_ParaMain::UrbanUpperRightX
- Upper right corner of urban prediction area (x coordinate).
- UrbanUpperRightY
-
- double WinProp_ParaMain::UrbanUpperRightY
- Upper right corner of urban prediction area (y coordinate).
- RuralLowerLeftX
-
- double WinProp_ParaMain::RuralLowerLeftX
- Lower left corner of rural prediction area (x coordinate).
- RuralLowerLeftY
-
- double WinProp_ParaMain::RuralLowerLeftY
- Lower left corner of rural prediction area (y coordinate).
- RuralUpperRightX
-
- double WinProp_ParaMain::RuralUpperRightX
- Upper right corner of rural prediction area (x coordinate).
- RuralUpperRightY
-
- double WinProp_ParaMain::RuralUpperRightY
- Upper right corner of rural prediction area (y coordinate).
- Resolution
-
- double WinProp_ParaMain::Resolution
- Resolution for prediction (meter). In case of prediction model 3D Intelligent Ray Tracing (PredictionModelUrban set to PREDMODEL_IRT) only preprocessed resolutions can be used.
- NrLayers
-
- int WinProp_ParaMain::NrLayers
- Number of prediction layers
- PredictionHeights
-
- double * WinProp_ParaMain::PredictionHeights
- Heights for prediction (meter). Array of length NrLayers. In case of prediction model 3D Intelligent Ray Tracing (PredictionModelUrban set to PREDMODEL_IRT) only preprocessed heights can be used.
- NrTimeInstances
-
- int WinProp_ParaMain::NrTimeInstances
- Number of time instances for time-variant simulation.
- TimeInstances
-
- double * WinProp_ParaMain::TimeInstances
- Time instances (second) for time-variant simulation. Array of length NrTimeInstances.
- AbsolutePredictionHeight
-
- int WinProp_ParaMain::AbsolutePredictionHeight
- Consider prediction height as absolute above sea level. Supported only by some prediction models.
- 0 = prediction height is relative
- 1 = prediction height is absolute
- VectorRadius
-
- double WinProp_ParaMain::VectorRadius
- Vector radius if necessary. Not yet used
- BreakpointMode
-
- WINPROP_BREAKPOINT_MODE WinProp_ParaMain::BreakpointMode
- Computation of breakpoint distance.
- BreakpointFactor
-
- double WinProp_ParaMain::BreakpointFactor
- Factor for determination of breakpoint distance, allowed range [1, 20]. Only required if BreakpointMode is NOT set to BREAKPOINT_FIXED.
- BreakpointOffset
-
- double WinProp_ParaMain::BreakpointOffset
- Offset (meter) for determination of breakpoint distance, allowed range [0, 10000]. Only required if BreakpointMode is NOT set to BREAKPOINT_FIXED.
- BreakpointDistance
-
- double WinProp_ParaMain::BreakpointDistance
- Fixed distance (meter) for breakpoint, allowed range [0, 10000]. Only required if BreakpointMode is set to BREAKPOINT_FIXED.
- BuildingsMode
-
- WINPROP_BUILDINGS_MODE WinProp_ParaMain::BuildingsMode
- Type of the building database.
- BuildingHeights
-
- double WinProp_ParaMain::BuildingHeights
- Default building heights
- BuildingHeightsAbs
-
- int WinProp_ParaMain::BuildingHeightsAbs
- Mode for building heights. Only relevant if BuildingsMode is set to BUILDINGSMODE_RAM.
- 0 = height relative to ground
- 1 = height absolute
- BuildingsMaterialsInd
-
- int WinProp_ParaMain::BuildingsMaterialsInd
- Individual materials or not. Only applicable in combination with WinProp database (BuildingsMode set to BUILDINGSMODE_BINARY, BUILDINGSMODE_IRT or BUILDINGSMODE_UDP (.odb, .oib, .opb))
- 0 = default materials
- 1 = individual materials
- BuildingsTransmissionLoss
-
- double WinProp_ParaMain::BuildingsTransmissionLoss
- Transmission loss of buildings (dB)
- Buildings
-
- URBAN_BUILDINGS WinProp_ParaMain::Buildings
- Data structure if the buildings should be read from RAM (BuildingsMode set to BUILDINGSMODE_RAM)
- BuildingsName
-
- WinProp_Filename WinProp_ParaMain::BuildingsName
- Filename of WinProp vector database. Can be relative to project file. Only applicable if BuildingsMode is not set to BUILDINGSMODE_RAM or BUILDINGSMODE_NONE.
- BuildingsIndoorCoverage
-
- WINPROP_INDOOR_COVERAGE_MODE WinProp_ParaMain::BuildingsIndoorCoverage
- Prediction of indoor coverage (inside building polygons).
- TopographyMode
-
- WINPROP_OUTDOOR_TOPO_MODE WinProp_ParaMain::TopographyMode
- The topography mode.
- Topography
-
- TOPOGRAPHY WinProp_ParaMain::Topography
- Topography data, only relevant in case TopographyMode is set to TOPOMODE_RAM
- TopographyName
-
- WinProp_Filename WinProp_ParaMain::TopographyName
- Filename of the topography database, only relevant in case TopographyMode is set to TOPOMODE_SEPARATE
- TopographyIndexDatabase
-
- bool WinProp_ParaMain::TopographyIndexDatabase
- True to topography index database in TopographyName, only relevant in case TopographyMode is set to TOPOMODE_SEPARATE
- TopographyHeightMode
-
- int WinProp_ParaMain::TopographyHeightMode
- Topo database includes buildings (0) or not (1)
- ClutterMode
-
- WINPROP_CLUTTER_MODE WinProp_ParaMain::ClutterMode
- The clutter mode.
- ClutterConsideration
-
- WINPROP_CLUTTER_HEIGHT_MODE WinProp_ParaMain::ClutterConsideration
- The clutter heights type.
- ClutterAttenuation
-
- WINPROP_CLUTTER_ATTENUATION_MODE WinProp_ParaMain::ClutterAttenuation
- Mode for clutter frequency depending losses.
- ClutterIntervalsNumber
-
- int WinProp_ParaMain::ClutterIntervalsNumber
- Clutter attenuation; Number of intervals with different weight factor. Only relevant if ClutterAttenuation is set to CLUTTERATTENUATION_RAY_DECREASE
- ClutterIntervalsLength
-
- float WinProp_ParaMain::ClutterIntervalsLength
- Clutter attenuation; Min length of interval. Only relevant if ClutterAttenuation is set to CLUTTERATTENUATION_RAY_DECREASE
- ClutterCalibration
-
- int WinProp_ParaMain::ClutterCalibration
- Calibrate clutter classes.
- 0 = no
- 1 = yes, without calculating mean error
- 2 = yes, with mean error as an output
- Clutter
-
- CLUTTER WinProp_ParaMain::Clutter
- Clutter data, only relevant in case ClutterMode is set to CLUTTERMODE_RAM
- ClutterName
-
- WinProp_Filename WinProp_ParaMain::ClutterName
- Filename of the clutter database, only relevant in case ClutterMode is set to CLUTTERMODE_FILE
- ClutterIndexDatabase
-
- bool WinProp_ParaMain::ClutterIndexDatabase
- True to clutter index database in ClutterName, only relevant in case ClutterMode is set to CLUTTERMODE_FILE
- ClutterClassesName
-
- WinProp_Filename WinProp_ParaMain::ClutterClassesName
- Filename of the clutter classes file, only relevant in case ClutterMode is set to CLUTTERMODE_FILE
- VegetationMode
-
- WINPROP_VEGETATION_MODE WinProp_ParaMain::VegetationMode
- The vegetation mode.
- VegetationName
-
- WinProp_Filename WinProp_ParaMain::VegetationName
- Filename of the vegetation file, only relevant in case VegetationMode is set to either VEGETATION_PIXEL or VEGETATION_SEPARATE. Filename without extension
- VegetationPropertiesInd
-
- int WinProp_ParaMain::VegetationPropertiesInd
- Individual vegetation properties.
- 0 = no
- 1 = yes
- VegetationLossFixed
-
- double WinProp_ParaMain::VegetationLossFixed
- The vegetation loss fixed
- VegetationLossPerMeter
-
- double WinProp_ParaMain::VegetationLossPerMeter
- The vegetation loss per meter
- VegetationResolution
-
- double WinProp_ParaMain::VegetationResolution
- The resolution used to create vegetation blocks out of large vegetation polygons in case of topography. This is done to allow the vegetation to adapt to the topography. Individual vegetation objects have at max the size of the set number in square meter. All created blocks together will have the same shape as the original polygons.
- BuildingsPixelMode
-
- unsigned int WinProp_ParaMain::BuildingsPixelMode
- Use urban buildings from pixel database.
- 0 = no buildings from pixel database
- 1 = use buildings from RAM See also BuildingsPixel
- 2 = load buildings from pixel database, file has to be specified in BuildingsPixelName
- BuildingsPixel
-
- TOPOGRAPHY WinProp_ParaMain::BuildingsPixel
- Structure for pixel buildings
- BuildingsPixelName
-
- WinProp_Filename WinProp_ParaMain::BuildingsPixelName
- Filename of the pixel buildings file, only relevant in case BuildingsPixelMode is set to 2.
- BuildingsPixelHeightMode
-
- int WinProp_ParaMain::BuildingsPixelHeightMode
- Mode for pixel building heights.
- 0 = height relative to ground
- 1 = height absolute
- BuildingsPixelHeightTolerance
-
- double WinProp_ParaMain::BuildingsPixelHeightTolerance
- Height tolerance [m] for pixel building heights
- ConsiderDatabasePolygons
-
- int WinProp_ParaMain::ConsiderDatabasePolygons
- Consider the database polygons if they are defined in the scenario (enabled/disabled)
- 0 = don't consider database polygons
- 1 = consider database polygons
- NrDatabasePolygons
-
- int WinProp_ParaMain::NrDatabasePolygons
- Number of database polygons in the scenario.
- DatabasePolygons
-
- WinProp_Polygon * WinProp_ParaMain::DatabasePolygons
- The database polygons in the scenario.
- FreqDepLosses
-
- WinProp_Additional_Freq_Loss WinProp_ParaMain::FreqDepLosses
- This structure allows to define additional frequency dependent losses (atmospheric losses).
- OutputResults
-
- WinProp_Propagation_Results * WinProp_ParaMain::OutputResults
- This structure allows to define additional results to be computed and written in binary WinProp format. Disabled by setting to NULL.
- Offset
-
- double WinProp_ParaMain::Offset
- Offset (dB) applied to all receiver pixels, allowed range [-100, 100].
- DistributedPrediction
-
- unsigned int WinProp_ParaMain::DistributedPrediction
- Distributed computations. Only modifies the output of errors, does not distribute the computations automatically across multiple PCs.
- 0 if prediction on local PC
- 1 if remote/distributed prediction
- Filter
-
- unsigned int WinProp_ParaMain::Filter
- Filter the results.
- 0 = no usage of filters
- 1 = use filters
- FilterOrder
-
- unsigned int WinProp_ParaMain::FilterOrder
- The filter order, if filter is used. The order must be an odd number, e.g. 1, 3, 5, ..See also Filter
- FilterMode
-
- unsigned int WinProp_ParaMain::FilterMode
- Type of filter, if filter is usedSee also FilterNOT USED ANYMORE
- FILTERMODE_MEAN : Mean value filtering.
- FILTERMODE_MEDIAN : Median value filtering.
- UseAntennaLimit
-
- bool WinProp_ParaMain::UseAntennaLimit
- True to limit the dynamic of the antennas
- AntennaLimit
-
- double WinProp_ParaMain::AntennaLimit
- The maximum dynamic of antennas. Only applicable if UseAntennaLimit is set to true
- ErrorMessageMain
-
- WinProp_ErrorString WinProp_ParaMain::ErrorMessageMain
- This is an output parameter! Contains an error message if an error occurs during a prediction.
- ErrorMessageSub
-
- WinProp_ErrorString WinProp_ParaMain::ErrorMessageSub
- This is an output parameter! Contains further information of the error in ErrorMessageMain, if an error occurs during a prediction.
- SupressMessageBoxes
-
- int WinProp_ParaMain::SupressMessageBoxes
- Suppress error messages.
- 0 = don't suppress errors
- 1 = suppress errors
- ModeAPI
-
- int WinProp_ParaMain::ModeAPI
- For internal usage only. DO NOT CHANGE!!
- MaxPathLossEnabled
-
- int WinProp_ParaMain::MaxPathLossEnabled
- Max absolute value of path loss of rays used to compute prediction results (enabled/disabled)
- 0 = don't limit max absolute value of path loss per ray
- 1 = limit max absolute value of path loss per ray, maximum has to be specified in MaxPathLoss
- MaxPathLoss
-
- float WinProp_ParaMain::MaxPathLoss
- The max absolute value of path loss of rays. Only applicable if MaxPathLossEnabled is set to 1
- MaxDynamicPathsEnabled
-
- int WinProp_ParaMain::MaxDynamicPathsEnabled
- Max dynamic range of path loss of rays used to compute prediction results (enabled/disabled)
- 0 = don't limit the dynamic range of rays
- 1 = limit the dynamic range of rays, maximum has to be specified in MaxDynamicPaths
- MaxDynamicPaths
-
- float WinProp_ParaMain::MaxDynamicPaths
- The maximum dynamic range path loss of rays. Only applicable if MaxDynamicPathsEnabled is set to 1
- MaxNumberPathsUsed
-
- int WinProp_ParaMain::MaxNumberPathsUsed
- Limit the number of rays which are computed.
- 0 = don't limit the number of rays
- 1 = limit the number of rays, maximum has to be specified in MaxNumberPaths
- MaxNumberPaths
-
- int WinProp_ParaMain::MaxNumberPaths
- The maximum number rays. Only applicable if MaxNumberPathsUsed is set to 1
- RaysLogLin
-
- int WinProp_ParaMain::RaysLogLin
- Define if the delay spread and angular spreads are computed
- 0 = with logarithmic values
- 1 = with linear values
- RaysPowerField
-
- int WinProp_ParaMain::RaysPowerField
- Define if the delay spread and angular spreads are computed based on
- 0 = power values
- 1 = field strength values
- IndoorPredictionOnly
-
- int WinProp_ParaMain::IndoorPredictionOnly
- Return results for indoor locations only from all computed results.
- 0 = get indoor and outdoor results
- 1 = get only indoor results
- ValueNotComputed
-
- double WinProp_ParaMain::ValueNotComputed
- The value, which represents not computed results
- BuildingsIndoorDecrease
-
- double WinProp_ParaMain::BuildingsIndoorDecrease
- For exponential decrease for variable decrease model, allowed range [0, 10]. Only relevant if BuildingsIndoorCoverage is set to COVERAGEINDOOR_USERDEFINED
- MultiThreading
-
- int WinProp_ParaMain::MultiThreading
- Number of threads being used for the computation of the particular antenna. Needs to be greater than zero. Currently not supported by any urban prediction model.
- FullPolarimetric
-
- int WinProp_ParaMain::FullPolarimetric
- Full polarimetric simulation (enabled/disabled)
- 0 = standard polarimetric analysis with total gain pattern only
- 1 = full polarimetric analysis with .ffe file or two gains patterns, one for vertical and one for horizontal polarisation
- RuralModeCNP
-
- int WinProp_ParaMain::RuralModeCNP
- RuralModeCNP (enabled/disabled)
- 0 = disabled
- 1 = enabled
- PredictionSurfaces
-
- int WinProp_ParaMain::PredictionSurfaces
- Enable prediction on building surfaces defined in the database
- 0 = Disable prediction on building surfaces
- 1 = Enable prediction on building surfaces
The documentation was generated from the following file:
- source/Interface/WP_ParaUrban.h