Functions for Wave Propagation Computation
Function List
- WinProp_Predict
- Start a prediction of wave propagation coverage.
- WinProp_Predict_Plane
- Compute a wave propagation prediction on an arbitrary plane in a scenario generated with WinProp_Open. Optional input parameters should be set to NULL if not used.
- WinProp_Predict_Points
- Compute wave propagation prediction between the antenna and given points. Scenario has to be opened with WinProp_Open before.
- WinProp_Predict_Trajectories
- Compute wave propagation prediction for a given trajectory. Scenario has to be opened with WinProp_Open before.
- WinProp_Calibrate_DPM
- This function is used to calibrate the dominant path model.
- WinProp_Result_GetAngles
- This function calculates elevation/azimuth angles at the BS or MS.
- WinProp_Coverage_Analysis
- Computes an interpolated map based on measurement data for a specified scenario opened with WinProp_Open.
Function Details
- int WinProp_Predict(int DataID, WinProp_Antenna * DataAntenna, WinProp_Area * DataArea, void * DataModelSettings, WinProp_Additional * Additional, WinProp_Result ** DataCoverageOut, WinProp_Result ** DataDelayOut, WinProp_Result ** DataNatureOfPathOut, WinProp_RayMatrix ** DataRaysOut, WinProp_Measurements * Measurements)
Description
Start a prediction of wave propagation coverage.Parameters
- int DataID
- Handle of wave propagation project.
- WinProp_Antenna * DataAntenna
- Configuration of antenna.
- WinProp_Area * DataArea
- Definition of prediction area.
- void * DataModelSettings
- Model settings (optional) of corresponding wave propagation model (see Model_DPM, Model_COST or Model_RAYTRACING).
- WinProp_Additional * Additional
- Definition of additional settings (optional).
- WinProp_Result ** DataCoverageOut
- Coverage prediction result.
- WinProp_Result ** DataDelayOut
- Delay prediction result.
- WinProp_Result ** DataNatureOfPathOut
- Result structure with path information.
- WinProp_RayMatrix ** DataRaysOut
- Ray matrix.
- WinProp_Measurements * Measurements
- Measurement data for calibration (optional).
Returns An integer: 0 = success, otherwise an error.
- int WinProp_Predict_Plane(int DataID, WinProp_Antenna * DataAntenna, WinProp_AreaPlane * DataArea, void * DataModelSettings, WinProp_Additional * Additional, WinProp_ResultPlane ** DataCoverageOut, WinProp_ResultPlane ** DataDelayOut, WinProp_ResultPlane ** DataNatureOfPathOut, WinProp_RayMatrix ** DataRaysOut, WinProp_Measurements * Measurements)
Description
Compute a wave propagation prediction on an arbitrary plane in a scenario generated with WinProp_Open. Optional input parameters should be set to NULL if not used.Parameters
- int DataID
- Handle of wave propagation project.
- WinProp_Antenna * DataAntenna
- Configuration of antenna (see WinProp_Antenna).
- WinProp_AreaPlane * DataArea
- Definition of arbitrary prediction area (see WinProp_AreaPlane).
- void * DataModelSettings
- Model settings (optional) of corresponding wave propagation model (Model_DPM, Model_COST or Model_RAYTRACING).
- WinProp_Additional * Additional
- Definition of additional settings (optional) WinProp_Additional.
- WinProp_ResultPlane ** DataCoverageOut
- Coverage prediction result (see WinProp_ResultPlane).
- WinProp_ResultPlane ** DataDelayOut
- Delay prediction result (see WinProp_ResultPlane).
- WinProp_ResultPlane ** DataNatureOfPathOut
- Path type result (see WinProp_ResultPlane).
- WinProp_RayMatrix ** DataRaysOut
- Propagation paths (see WinProp_RayMatrix).
- WinProp_Measurements * Measurements
- Measurement data for calibration (optional). This is not yet supported for prediction planes.
Returns An integer: 0 = success, otherwise an error.
- int WinProp_Predict_Points(int DataID, WinProp_Antenna * DataAntenna, WinProp_Receiver * DataReceiver, int NrReceiver, void * DataModelSettings, WinProp_Additional * Additional, WinProp_ResultPointsList ** DataResultOut)
Description
Compute wave propagation prediction between the antenna and given points. Scenario has to be opened with WinProp_Open before.Parameters
- int DataID
- Handle of wave propagation project.
- WinProp_Antenna * DataAntenna
- Non-null, configuration of antenna.
- WinProp_Receiver * DataReceiver
- Non-null, array of receiving points, of length equal to NrReceiver.
- int NrReceiver
- Number of receiving points.
- void * DataModelSettings
- If non-null, model settings (optional) of corresponding wave propagation model. Needs to be set to the to WinProp_Antenna::Model corresponding type:
- WINPROP_MODEL_FREESPACE
- WINPROP_MODEL_COST231 = Model_COST
- WINPROP_MODEL_DPM = Model_DPM
- WINPROP_MODEL_SRT
- WINPROP_MODEL_IRT.
- WinProp_Additional * Additional
- If non-null, definition of additional settings (optional).
- WinProp_ResultPointsList ** DataResultOut
- Non-null, structure containing the points results.
Returns An integer: 0 = success, otherwise an error.
- int WinProp_Predict_Trajectories(int DataID, WinProp_Antenna * DataAntenna, WinProp_Trajectory * DataTrajectories, int NrTrajectories, void * DataModelSettings, WinProp_Additional * Additional, WinProp_ResultTrajectoryList ** DataResultOut)
Description
Compute wave propagation prediction for a given trajectory. Scenario has to be opened with WinProp_Open before.Parameters
- int DataID
- Handle of wave propagation project.
- WinProp_Antenna * DataAntenna
- Non-null, configuration of antenna.
- WinProp_Trajectory * DataTrajectories
- Non-null, the trajectories. Array of size NrTrajectories.
- int NrTrajectories
- The number of trajectories.
- void * DataModelSettings
- If non-null, model settings (optional) of corresponding wave propagation model. Needs to be set to the to WinProp_Antenna::Model corresponding type:
- WINPROP_MODEL_FREESPACE
- WINPROP_MODEL_COST231 = Model_COST
- WINPROP_MODEL_DPM = Model_DPM
- WINPROP_MODEL_SRT
- WINPROP_MODEL_IRT.
- WinProp_Additional * Additional
- If non-null, definition of additional settings (optional).
- WinProp_ResultTrajectoryList ** DataResultOut
- Non-null, structure containing the trajectory results.
Returns An int.
- int WinProp_Calibrate_DPM(WinProp_Calib_DPM * Calibration)
Description
This function is used to calibrate the dominant path model.Parameters
- WinProp_Calib_DPM * Calibration
- Calibration data structure. See WinProp_Calib_DPM.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Result_GetAngles(int DataID, int x, int y, int z, int Ray, double * AzimuthBS, double * ElevationBS, double * AzimuthMS, double * ElevationMS)
Description
This function calculates elevation/azimuth angles at the BS or MS.Parameters
- int DataID
- ID of the project. See the first parameter in WinProp_Open.
- int x
- x coordinate matrix index.
- int y
- y coordinate matrix index.
- int z
- z coordinate matrix index.
- int Ray
- Ray index.
- double * AzimuthBS
- Azimuth (phi) at BS.
- double * ElevationBS
- Elevation (theta) at BS.
- double * AzimuthMS
- Azimuth (phi) at MS.
- double * ElevationMS
- Elevation (theta) at MS.
Returns An int.
- int WinProp_Coverage_Analysis(int In_DataID, WinProp_Area * In_DataArea, WinProp_Surveydata * In_DataSurvey, WinProp_Coverage_Para * In_CoveragePara, WinProp_Result ** Out_DataResult)
Description
Computes an interpolated map based on measurement data for a specified scenario opened with WinProp_Open.Parameters
- int In_DataID
- Handle of wave propagation project.
- WinProp_Area * In_DataArea
- Definition of prediction area (see WinProp_Area).
- WinProp_Surveydata * In_DataSurvey
- Measurement data (see WinProp_Surveydata).
- WinProp_Coverage_Para * In_CoveragePara
- Configuration of interpolation algorithm (see WinProp_Coverage_Para).
- WinProp_Result ** Out_DataResult
- Computed coverage (see WinProp_Result).
Returns An integer: 0 = success, failure otherwise.
The documentation was generated from the following file:
- source.eng/Interface/Engine.h