WinProp_Antenna

Data Fields

Detailed Description

Configuration of antenna.

Field Documentation

Enabled
int WinProp_Antenna::Enabled
Use transmitter or not. This parameter is influenced by the optimization module.
Id
int WinProp_Antenna::Id
Identifier of transmitter. The identifier must be greater than zero.
Longitude_X
double WinProp_Antenna::Longitude_X
Longitude or X coordinate of transmitter.
Latitude_Y
double WinProp_Antenna::Latitude_Y
Latitude or Y coordinate of transmitter.
Height
double WinProp_Antenna::Height
Height of transmitter.
PredictRadius
double WinProp_Antenna::PredictRadius
Predict an area around the transmitter.
Model
int WinProp_Antenna::Model
Wave propagation model used:
  • WINPROP_MODEL_FREESPACE
  • WINPROP_MODEL_COST231
  • WINPROP_MODEL_DPM
  • WINPROP_MODEL_SRT
  • WINPROP_MODEL_IRT (requires a preprocessed vector database [*.idi])
DataType
int WinProp_Antenna::DataType
Type of result to be computed:
  • PROP_RESULT_POWER
  • PROP_RESULT_FIELD
  • PROP_RESULT_PATHLOSS
DataMode
int WinProp_Antenna::DataMode
Type of propagation map assigned to this transmitter:
  • 0 = prediction result
  • 1 = interpolation result
Power
double WinProp_Antenna::Power
Transmit power in dBm.
PowerMode
int WinProp_Antenna::PowerMode
Power mode.
  • WINPROP_POWER_OUTPUT = Output power amplifier
  • WINPROP_POWER_EIRP = EIRP
  • WINPROP_POWER_ERP = ERP
TRXCableLoss
float WinProp_Antenna::TRXCableLoss
Static cable loss (dB) for transmitters not based on components
Frequency
double WinProp_Antenna::Frequency
Frequency in MHz.
Azimuth
double WinProp_Antenna::Azimuth
Azimuth in degrees. North over east orientation.
Downtilt
double WinProp_Antenna::Downtilt
Downtilt in degrees.
Type
int WinProp_Antenna::Type
Type of antenna:
  • 0 = ordinary antenna
  • 3 = radiating cable (only supported in indoor propagation)
Gain
double WinProp_Antenna::Gain
Gain of antenna in dBi.
Pattern
WinProp_Pattern * WinProp_Antenna::Pattern
Pattern of antenna total gain in case of standard project or gain for vertical polarization in case of full-polarimetric. If isotropic radiator, this can be NULL.
PatternPolHoriz
WinProp_Pattern * WinProp_Antenna::PatternPolHoriz
Pattern of antenna gain for horizontal polarization in case of full-polarimetric. If isotropic radiator or standard polarimetric analysis, this can be NULL.
Name
char * WinProp_Antenna::Name
Name of antenna. This must be unique.
NbrCableSegs
int WinProp_Antenna::NbrCableSegs
Number of cable segments (points) in CablePoints, if radiating cable.
CablePoints
COORDPOINT * WinProp_Antenna::CablePoints
Coordinates of points of radiating cable. Needs to be an array of size NbrCableSegs
CableLossPer100m
double WinProp_Antenna::CableLossPer100m
Cable loss for radiating cable per 100 m in dB.
CouplingLoss
double WinProp_Antenna::CouplingLoss
Coupling loss for radiating cable in dB.
DistCouplingLoss
double WinProp_Antenna::DistCouplingLoss
Distance coupling loss (m) for radiating cable.
CouplingGrad
double WinProp_Antenna::CouplingGrad
Gradient Coupling loss for radiating cable per 100 m in dB.
RepeaterStatus
int WinProp_Antenna::RepeaterStatus
Repeater status:
  • 0 = Ordinary sector
  • 1 = Urban sector which feeds repeaters
  • 2 = Repeater in indoor environment
  • 3 = outdoor sector (considered as noise only)
RepeaterIndex
int WinProp_Antenna::RepeaterIndex
If repeater (RepeaterStatus is not set to 0), this index contains the unique number of the sector.
HeightAbsolute
int WinProp_Antenna::HeightAbsolute
Height definition of antenna absolute (1) or relative (0).
RxNoiseFigure
float WinProp_Antenna::RxNoiseFigure
Noise figure of receiver [dB]. Only relevant for network planning (see WinProp_Net_Project_Open).
GroupIDMounted
int WinProp_Antenna::GroupIDMounted
In case of a time variant prediction, ID of group where antenna is mounted. The antenna location then is moved with the same vector like the specified group.
SignalMode
int WinProp_Antenna::SignalMode
Signal mode of the external site. Only relevant for external interference sites
  • 0 = Constant Signal Power.
  • 1 = Signal Power from a Result File.
PowerConstant
float WinProp_Antenna::PowerConstant
Constant interference power level [dBm]. Only relevant for external interference sites with signal mode = 0 (Constant Signal Power).
PowerResultFile
char * WinProp_Antenna::PowerResultFile
File name defining the interference power level. Only relevant for external interference sites with signal mode = 1 (Signal Power from a Result File).
BandType
int WinProp_Antenna::BandType
Type of interference signal. Only relevant for external interference sites.
  • 0 = In-band interference (interference due to an external source radiating on a carrier frequency used in the project).
  • 1 = Out-of-band interference (interference due to leakage of external signals into frequency bands used in the project).
CarrierID
int WinProp_Antenna::CarrierID
Identifier of the victim carrier. Only relevant for external interference sites with band type = 0 (in-band interference).
LeakageRatio
float WinProp_Antenna::LeakageRatio
Leakage ratio [dB]. Only relevant for external interference sites with band type = 1 (Out-of-band interference).
Carriers
WinProp_Carrier WinProp_Antenna::Carriers
Carriers definition, only relevant for network planning
The documentation was generated from the following file:
  • source.eng/Interface/WP_Antenna.h