Skip to content

DiGi.GIS.WebAPI.UI.Classes

github-actions[bot] edited this page Aug 21, 2026 · 7 revisions

DiGi.GIS.WebAPI.UI.Classes Namespace

Classes

AntennaParameter Class

Represents a single antenna sent by the communication 3D view: its world location and the communication functions selected by the user (mapped to DiGi.Communication.Enums.Function).

public class AntennaParameter

Inheritance System.Object → AntennaParameter

Properties

AntennaParameter.Functions Property

Gets or sets the names of the selected DiGi.Communication.Enums.Function values (e.g. Transmitter, Receiver).

public System.Collections.Generic.List<string>? Functions { get; set; }

Property Value

System.Collections.Generic.List<System.String>

AntennaParameter.X Property

Gets or sets the X coordinate of the antenna in world coordinates.

public double X { get; set; }

Property Value

System.Double

AntennaParameter.Y Property

Gets or sets the Y coordinate of the antenna in world coordinates.

public double Y { get; set; }

Property Value

System.Double

AntennaParameter.Z Property

Gets or sets the height of the antenna top above the ground plane (Z = 0) in meters.

public double Z { get; set; }

Property Value

System.Double

CommunicationCalculationParameter Class

Represents the payload of a communication calculation request sent by the communication 3D view: the analyzed circular area (used to fetch the buildings on the fly) and the antennas placed by the user.

public class CommunicationCalculationParameter

Inheritance System.Object → CommunicationCalculationParameter

Properties

CommunicationCalculationParameter.Antennas Property

Gets or sets the antennas placed by the user in the 3D view.

public System.Collections.Generic.List<DiGi.GIS.WebAPI.UI.Classes.AntennaParameter>? Antennas { get; set; }

Property Value

System.Collections.Generic.List<AntennaParameter>

CommunicationCalculationParameter.CenterX Property

Gets or sets the X coordinate of the center of the analyzed circular area.

public double CenterX { get; set; }

Property Value

System.Double

CommunicationCalculationParameter.CenterY Property

Gets or sets the Y coordinate of the center of the analyzed circular area.

public double CenterY { get; set; }

Property Value

System.Double

CommunicationCalculationParameter.Conductivity Property

Gets or sets the default electrical conductivity applied to the scattering object mesh cells [S/m].

public System.Nullable<double> Conductivity { get; set; }

Property Value

System.Nullable<System.Double>

CommunicationCalculationParameter.DefaultSimpleMultipathPowerDelayProfile Property

Gets or sets the default simple multipath power delay profile name.

public string? DefaultSimpleMultipathPowerDelayProfile { get; set; }

Property Value

System.String

CommunicationCalculationParameter.Frequency Property

Gets or sets the frequency of the propagating electromagnetic wave [Hz].

The 3D view collects the value in MHz and converts it before sending; when omitted the DiGi.Communication.Classes.AngularPowerDistributionSolverOptions default is used.

public System.Nullable<double> Frequency { get; set; }

Property Value

System.Nullable<System.Double>

CommunicationCalculationParameter.Polarization Property

Gets or sets the polarization type of the propagating electromagnetic wave (Vertical or Horizontal).

public string? Polarization { get; set; }

Property Value

System.String

CommunicationCalculationParameter.Radius Property

Gets or sets the radius of the analyzed circular area in meters.

public double Radius { get; set; }

Property Value

System.Double

CommunicationCalculationParameter.RelativePermittivity Property

Gets or sets the default relative electrical permittivity applied to the scattering object mesh cells [-].

public System.Nullable<double> RelativePermittivity { get; set; }

Property Value

System.Nullable<System.Double>

Clone this wiki locally