Functions for Wave Propagation Computation

Function List

WinProp_Predict: Start a prediction of wave propagation coverage.
WinProp_Predict_Planes: Compute a wave propagation prediction on arbitrary planes 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, const WinProp_Antenna * DataAntenna, const WinProp_Area * DataArea, const WinProp_Receiver * DataReceiver, int NrReceiver, const void * DataModelSettings, const WinProp_Additional * Additional, WinProp_Result ** DataCoverageOut, WinProp_Result ** DataDelayOut, WinProp_Result ** DataNatureOfPathOut, WinProp_RayMatrix ** DataRaysOut, WinProp_ResultPlaneList ** PlanesResultOut, WinProp_RayMatrixList ** PlanesRaysOut, const WinProp_Measurements * Measurements)

Description

Start a prediction of wave propagation coverage.

Parameters

int DataID: Handle of wave propagation project.
const WinProp_Antenna * DataAntenna: Configuration of antenna.
const WinProp_Area * DataArea: Definition of prediction area.
const WinProp_Receiver * DataReceiver: If Non-null, represents the receiving points at repeaters antennas.
int NrReceiver: Number of receiving points at repeaters antennas.
const void * DataModelSettings: Model settings (optional) of corresponding wave propagation model (see Model_DPM, Model_COST or Model_RAYTRACING).
const 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_ResultPlaneList ** PlanesResultOut: If non-null, result structure containing the prediction result for the arbitrary prediction planes defined in the database.
WinProp_RayMatrixList ** PlanesRaysOut: If non-null, result structure containing the ray matrix for the arbitrary prediction planes defined in the database.
const WinProp_Measurements * Measurements: Measurement data for calibration (optional).

Returns An integer: 0 = success, otherwise an error.

int WinProp_Predict_Planes(int DataID, const WinProp_Antenna * DataAntenna, int NrPlaneAreas, const WinProp_AreaPlane * DataAreas, const void * DataModelSettings, const WinProp_Additional * Additional, WinProp_ResultPlaneList ** DataCoverageOut, WinProp_ResultPlaneList ** DataDelayOut, WinProp_ResultPlaneList ** DataNatureOfPathOut, WinProp_RayMatrixList ** DataRaysOut, const WinProp_Measurements * Measurements)

Description

Compute a wave propagation prediction on arbitrary planes 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.
const WinProp_Antenna * DataAntenna: Configuration of antenna (see WinProp_Antenna).
int NrPlaneAreas: Number of arbitrary prediction areas (prediction planes).
const WinProp_AreaPlane * DataAreas: Definition of arbitrary prediction areas (prediction planes) (see WinProp_AreaPlane).
const void * DataModelSettings: Model settings (optional) of corresponding wave propagation model (Model_DPM, Model_COST or Model_RAYTRACING).
const WinProp_Additional * Additional: Definition of additional settings (optional) WinProp_Additional.
WinProp_ResultPlaneList ** DataCoverageOut: Coverage prediction result (see WinProp_ResultPlaneList).
WinProp_ResultPlaneList ** DataDelayOut: Delay prediction result (see WinProp_ResultPlaneList).
WinProp_ResultPlaneList ** DataNatureOfPathOut: Path type result (see WinProp_ResultPlaneList).
WinProp_RayMatrixList ** DataRaysOut: Propagation paths (see WinProp_RayMatrixList).
const 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, const WinProp_Antenna * DataAntenna, const WinProp_Receiver * DataReceiver, int NrReceiver, const void * DataModelSettings, const WinProp_Additional * Additional, WinProp_ResultPointsList ** DataResultOut, WinProp_ResultPlaneList ** PlanesResultOut, WinProp_RayMatrixList ** PlanesRaysOut)

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.
const WinProp_Antenna * DataAntenna: Non-null, configuration of antenna.
const WinProp_Receiver * DataReceiver: Non-null, array of receiving points, of length equal to NrReceiver.
int NrReceiver: Number of receiving points.
const 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_INDOOR.
const WinProp_Additional * Additional: If non-null, definition of additional settings (optional).
WinProp_ResultPointsList ** DataResultOut: Non-null, structure containing the points results.
WinProp_ResultPlaneList ** PlanesResultOut: If non-null, structure containing the prediction result for the arbitrary prediction planes defined in the database.
WinProp_RayMatrixList ** PlanesRaysOut: If non-null, result structure containing the ray matrix for the arbitrary prediction planes defined in the database.

Returns An integer: 0 = success, otherwise an error.

int WinProp_Predict_Trajectories(int DataID, const WinProp_Antenna * DataAntenna, const WinProp_Trajectory * DataTrajectories, int NrTrajectories, const void * DataModelSettings, const WinProp_Additional * Additional, WinProp_ResultTrajectoryList ** DataResultOut, WinProp_ResultPlaneList ** PlanesResultOut, WinProp_RayMatrixList ** PlanesRaysOut)

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.
const WinProp_Antenna * DataAntenna: Non-null, configuration of antenna.
const WinProp_Trajectory * DataTrajectories: Non-null, the trajectories. Array of size NrTrajectories.
int NrTrajectories: The number of trajectories.
const 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_INDOOR.
const WinProp_Additional * Additional: If non-null, definition of additional settings (optional).
WinProp_ResultTrajectoryList ** DataResultOut: Non-null, structure containing the trajectory results.
WinProp_ResultPlaneList ** PlanesResultOut: If non-null, structure containing the prediction result for the arbitrary prediction planes defined in the database.
WinProp_RayMatrixList ** PlanesRaysOut: If non-null, result structure containing the ray matrix for the arbitrary prediction planes defined in the database.

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, const WinProp_Area * In_DataArea, const WinProp_Surveydata * In_DataSurvey, const 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.
const WinProp_Area * In_DataArea: Definition of prediction area (see WinProp_Area).
const WinProp_Surveydata * In_DataSurvey: Measurement data (see WinProp_Surveydata).
const 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/Interface/Engine.h