Functions for computing total power

Function List

WinProp_Total_Power
Computation of the power superposition for a set of power results
WinProp_Total_Power_Points
Computation of the power superposition for a set of prediction point power results
WinProp_Total_Power_Trajectories
Computation of the power superposition for a set of prediction trajectory power results
WinProp_Total_Power_Planes
Computation of the power superposition for a set of prediction plane power results

Function Details

int WinProp_Total_Power(const int NrResults, const WinProp_Result * PowerResults, const WinProp_RayMatrix * RayMatrices, const TOTAL_POWER_MODE Mode, const float Frequency, const WinProp_Callback * WinPropCallback, WinProp_Result * TotalPower)

Description

Computation of the power superposition for a set of power results

Parameters

const int NrResults
The number of results to superpose.
const WinProp_Result * PowerResults
The power results to superpose. This is an array of size equal to NrResults.
const WinProp_RayMatrix * RayMatrices
The ray matrices to superpose. This is an array of size equal to NrResults. Only relevant if mode = TOTAL_POWER_MODE::COHERENT.
const TOTAL_POWER_MODE Mode
The power superposition mode see TOTAL_POWER_MODE.
const float Frequency
The frequency of the results in [MHz].
const WinProp_Callback * WinPropCallback
The configuration of callback functions (see WinProp_Callback).
WinProp_Result * TotalPower
If non-null, the total power for the input results.

Returns An integer: 0 = success, failure otherwise.

int WinProp_Total_Power_Points(const int NrResults, const WinProp_ResultPointsList * PointLists, const TOTAL_POWER_MODE Mode, const float Frequency, const WinProp_Callback * WinPropCallback, WinProp_ResultPointsList * TotalPowerPoints)

Description

Computation of the power superposition for a set of prediction point power results

Parameters

const int NrResults
The number of results to superpose.
const WinProp_ResultPointsList * PointLists
The point lists results to superpose. This is an array of size equal to NrResults.
const TOTAL_POWER_MODE Mode
The power superposition mode see TOTAL_POWER_MODE.
const float Frequency
The frequency of the results in [MHz].
const WinProp_Callback * WinPropCallback
The configuration of callback functions (see WinProp_Callback).
WinProp_ResultPointsList * TotalPowerPoints
If non-null, the total power for the input point lists.

Returns An integer: 0 = success, failure otherwise.

int WinProp_Total_Power_Trajectories(const int NrResults, const WinProp_ResultTrajectoryList * TrajectoryLists, const TOTAL_POWER_MODE Mode, const float Frequency, const WinProp_Callback * WinPropCallback, WinProp_ResultTrajectoryList * TotalPowerTrajectories)

Description

Computation of the power superposition for a set of prediction trajectory power results

Parameters

const int NrResults
The number of results to superpose.
const WinProp_ResultTrajectoryList * TrajectoryLists
The trajectory lists results to superpose. This is an array of size equal to NrResults.
const TOTAL_POWER_MODE Mode
The power superposition mode see TOTAL_POWER_MODE.
const float Frequency
The frequency of the results in [MHz].
const WinProp_Callback * WinPropCallback
The configuration of callback functions (see WinProp_Callback).
WinProp_ResultTrajectoryList * TotalPowerTrajectories
If non-null, the total power for the input trajectory lists.

Returns An integer: 0 = success, failure otherwise.

int WinProp_Total_Power_Planes(const int NrResults, const WinProp_ResultPlaneList * PowerResultPlanes, const WinProp_RayMatrixList * RayMatrixPlanes, const TOTAL_POWER_MODE Mode, const float Frequency, const WinProp_Callback * WinPropCallback, WinProp_ResultPlaneList * TotalPowerPlanes)

Description

Computation of the power superposition for a set of prediction plane power results

Parameters

const int NrResults
The number of results to superpose.
const WinProp_ResultPlaneList * PowerResultPlanes
The power results to superpose. This is an array of size equal to NrResults.
const WinProp_RayMatrixList * RayMatrixPlanes
The ray matrices to superpose. This is an array of size equal to NrResults. Only relevant if mode = TOTAL_POWER_MODE::COHERENT.
const TOTAL_POWER_MODE Mode
The power superposition mode see TOTAL_POWER_MODE.
const float Frequency
The frequency of the results in [MHz].
const WinProp_Callback * WinPropCallback
The configuration of callback functions (see WinProp_Callback).
WinProp_ResultPlaneList * TotalPowerPlanes
If non-null, the total power for the input plane results.

Returns An integer: 0 = success, failure otherwise.

The documentation was generated from the following file:
  • source/Interface/EngineTotalPower.h