Repository navigation
DiGi.GIS.WebAPI.UI.Controllers
Provides API endpoints for managing and retrieving 2D administrative areal data.
public class AdministrativeAreal2DController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → AdministrativeAreal2DController
Initializes a new instance of the AdministrativeAreal2DController class.
public AdministrativeAreal2DController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create HTTP clients.
Searches for administrative area reference paths by name.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencePathsByNameAsync(string text);text System.String
The text to search for within the name column.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation, containing the result of the search.
AdministrativeAreal2DController.GetAdministrativeAreal2DReferencesByAdministrativeArealTypeAsync(string, Nullable<int>, Nullable<bool>) Method
Retrieves administrative 2D area references based on the specified administrative areal type, parent identifier, and unique code filter.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencesByAdministrativeArealTypeAsync(string administrativeArealType, System.Nullable<int> parentId, System.Nullable<bool> uniqueCode);administrativeArealType System.String
The type of the administrative area.
parentId System.Nullable<System.Int32>
The optional identifier of the parent administrative area.
uniqueCode System.Nullable<System.Boolean>
An optional flag indicating whether to filter by unique code.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation result.
Retrieves administrative areal 2D references by the specified code asynchronously.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencesByCodeAsync(string code);code System.String
The code used to retrieve the administrative areal 2D references.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation result.
Retrieves the administrative areal 2D references by their identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencesByIdAsync(int id);id System.Int32
The unique identifier of the administrative areal 2D reference.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult.
Retrieves an administrative areal 2D item by its specified code.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByCodeAsync(string code);code System.String
The code of the item to retrieve.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult.
Retrieves items filtered by the specified administrative area type.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemsByAdministrativeArealTypeAsync(string administrativeArealType);administrativeArealType System.String
The administrative area type (e.g., country, voivodeship, county, municipality) to filter by.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation result containing the items or an error response.
Retrieves polygons associated with a specific administrative areal identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetPolygonsByIdAsync(int id, System.Nullable<double> reductionFactor=null, System.Nullable<int> minCount=null);id System.Int32
The unique identifier of the administrative areal.
reductionFactor System.Nullable<System.Double>
The optional reduction factor used to simplify the geometry of the retrieved polygons.
minCount System.Nullable<System.Int32>
The optional minimum count for filtering the results.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A Microsoft.AspNetCore.Mvc.IActionResult representing the result of the request.
Starts the Administrative Areal 2D view.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result that renders the start view.
Provides API endpoints for managing and retrieving building 2D information.
public class Building2DController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → Building2DController
Initializes a new instance of the Building2DController class.
public Building2DController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create System.Net.Http.HttpClient instances.
Asynchronously retrieves building 2D references associated with the specified administrative areal 2D identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuilding2DReferencesByAdministrativeAreal2DIdAsync(int administrativeAreal2DId);administrativeAreal2DId System.Int32
The administrative areal 2D identifier to filter by.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation.
Building2DController.GetDetailsByReferenceAsync(string, Nullable<int>, Nullable<double>, Nullable<double>) Method
Renders the standalone building details page for the specified building reference (used e.g. by the "Show" button of the 3D viewer "Details" panel).
The partial view _Building2DView cannot be rendered on its own: it depends on the scripts, styles and AJAX loading logic of the references master-detail layout. The building context is therefore injected into Building2DDetailsView, which renders only the details side and loads the partial through the same AJAX pipeline.
The building data is partitioned per county, so the by-reference lookup requires a county identifier. When it is not provided, it is resolved from the optional x/y point (e.g. the building centroid known to the 3D viewer).
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetDetailsByReferenceAsync(string? reference, System.Nullable<int> countyId=null, System.Nullable<double> x=null, System.Nullable<double> y=null);reference System.String
The unique reference string of the building.
countyId System.Nullable<System.Int32>
The optional unique identifier of the county associated with the building.
x System.Nullable<System.Double>
The optional X coordinate of a point inside the building used to resolve the county when countyId is not provided.
y System.Nullable<System.Double>
The optional Y coordinate of a point inside the building used to resolve the county when countyId is not provided.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> rendering the building details page.
Asynchronously retrieves a building 2D item by its unique identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByIdAsync(long id, System.Nullable<int> countyId);id System.Int64
The unique identifier of the item to retrieve.
countyId System.Nullable<System.Int32>
The optional unique identifier of the county associated with the item.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation, containing the Microsoft.AspNetCore.Mvc.IActionResult result.
Asynchronously retrieves 2D points based on a collection of references and an optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetPointsByReferencesAsync(System.Collections.Generic.IEnumerable<string> references, System.Nullable<int> countyId);references System.Collections.Generic.IEnumerable<System.String>
The collection of string references used to identify the building points.
countyId System.Nullable<System.Int32>
The optional integer identifier of the county associated with the buildings.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult.
Building2DController.GetPolygonByIdAsync(long, Nullable<int>, Nullable<double>, Nullable<int>) Method
Retrieves a polygon by its unique identifier asynchronously.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetPolygonByIdAsync(long id, System.Nullable<int> countyId, System.Nullable<double> reductionFactor=null, System.Nullable<int> minCount=null);id System.Int64
The unique identifier of the polygon.
countyId System.Nullable<System.Int32>
The optional county identifier used to filter the request.
reductionFactor System.Nullable<System.Double>
The optional reduction factor for simplifying the polygon geometry.
minCount System.Nullable<System.Int32>
The optional minimum count threshold for the data retrieval.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation result containing the requested polygon data.
Initializes and returns the start view for the 2D building interface.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result that renders the starting view.
Provides controller endpoints for accessing and managing building data, acting as an interface between the client and the underlying GIS building data services.
public class BuildingDataController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → BuildingDataController
Initializes a new instance of the BuildingDataController class.
public BuildingDataController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create and manage System.Net.Http.HttpClient instances for making API requests.
Asynchronously retrieves a building data table based on the specified reference and an optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetTableByReferenceAsync(string reference, System.Nullable<int> countyId=null);reference System.String
The unique reference string used to look up the table.
countyId System.Nullable<System.Int32>
The optional ID of the county associated with the request.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult representing the HTTP response.
Handles the HTTP GET request to the root endpoint and returns the starting view for building data operations.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult representing the start view.
Provides controller endpoints for accessing analytical DiGi.Analytical.Building.Classes.BuildingModel data, acting as an interface between the client and the underlying GIS building data services.
public class BuildingModelController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → BuildingModelController
Initializes a new instance of the BuildingModelController class.
public BuildingModelController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create and manage System.Net.Http.HttpClient instances for making API requests.
Renders the 3D viewer page for a single building. The page itself carries no geometry; the viewer streams the binary glTF payload from the glb endpoint.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuildingModelByIdAsync(long id, System.Nullable<int> countyId, System.Nullable<double> storeyHeight=null);id System.Int64
The unique identifier of the building.
countyId System.Nullable<System.Int32>
The optional unique identifier of the county associated with the building.
storeyHeight System.Nullable<System.Double>
The optional storey height in meters used for the extrusion.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult rendering the glTF scene view.
BuildingModelController.GetBuildingsGLBByRadiusAsync(double, double, double, Nullable<double>, CancellationToken) Method
Asynchronously retrieves all building models within the specified circular area from the PostgreSQL database via the GIS Web API, converts each DiGi.Analytical.Building.Classes.BuildingModel into a batched DiGi.GLTF.Classes.GLTFScene with buildings selectable as whole envelopes and streams it as a binary glTF (.glb) payload.
The search is purely spatial: the area may span multiple counties, so no county identifier is required.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuildingsGLBByRadiusAsync(double centerX, double centerY, double radius, System.Nullable<double> storeyHeight=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));centerX System.Double
The X coordinate of the center of the search circle.
centerY System.Double
The Y coordinate of the center of the search circle.
radius System.Double
The radius of the search circle in meters.
storeyHeight System.Nullable<System.Double>
The optional storey height in meters used for the extrusions.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> holding the .glb file.
Asynchronously creates a DiGi.Analytical.Building.Classes.BuildingModel for the building with the specified unique identifier (see BuildingModelAsync(this HttpClient, long, Nullable<int>, double, double)), converts each of its components (walls, floors and roofs) into a separate node of a batched DiGi.GLTF.Classes.GLTFScene (translated to a local origin) and streams it as a binary glTF (.glb) payload.
Each component carries its own identity in the scene object map, so the 3D viewer can hit-test and select individual components instead of the building as a whole.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetGLBBuildingModelByIdAsync(long id, System.Nullable<int> countyId, System.Nullable<double> storeyHeight=null);id System.Int64
The unique identifier of the building.
countyId System.Nullable<System.Int32>
The optional unique identifier of the county associated with the building.
storeyHeight System.Nullable<System.Double>
The optional storey height in meters used for the extrusion.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> holding the .glb file.
Asynchronously creates a DiGi.Analytical.Building.Classes.BuildingModel for the building with the specified unique identifier (see BuildingModelAsync(this HttpClient, long, Nullable<int>, double, double)) and returns it as JSON.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByIdAsync(long id, System.Nullable<int> countyId);id System.Int64
The unique identifier of the building.
countyId System.Nullable<System.Int32>
The optional unique identifier of the county associated with the building.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> holding the serialized DiGi.Analytical.Building.Classes.BuildingModel.
Asynchronously loads a DiGi.Analytical.Building.Classes.BuildingModel from the GIS Web API by searching for the building at the specified coordinates, converts its components into separate selectable DiGi.GLTF.Classes.GLTFNode instances and renders the 3D viewer page.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByReferenceAsync(string reference, double x, double y);reference System.String
The reference of the building model.
The X coordinate of the building centroid.
The Y coordinate of the building centroid.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> rendering the 3D glTF scene view or a not found response.
Renders the 3D viewer page for all buildings within the specified circular area. The page itself carries no geometry; the viewer streams the binary glTF payload from the glb endpoint.
The search is purely spatial: the area may span multiple counties, so no county identifier is required.
public Microsoft.AspNetCore.Mvc.IActionResult GetItemsByRadius(double centerX, double centerY, double radius, System.Nullable<double> storeyHeight=null);centerX System.Double
The X coordinate of the center of the search circle.
centerY System.Double
The Y coordinate of the center of the search circle.
radius System.Double
The radius of the search circle in meters.
storeyHeight System.Nullable<System.Double>
The optional storey height in meters used for the extrusions.
Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult rendering the glTF scene view.
Handles the HTTP GET request to the root endpoint and returns the 3D viewer landing page.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult representing the start view.
Provides the communication analysis feature: an input page for the analyzed circular area, the 3D scene view with the antenna toolbar and the calculation endpoint bridging the 3D view with the GIS agnostic DiGi.Communication.WebAPI service.
public class CommunicationController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → CommunicationController
Initializes a new instance of the CommunicationController class.
public CommunicationController(System.Net.Http.IHttpClientFactory httpClientFactory, Microsoft.AspNetCore.Hosting.IWebHostEnvironment webHostEnvironment);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create System.Net.Http.HttpClient instances.
webHostEnvironment Microsoft.AspNetCore.Hosting.IWebHostEnvironment
The Microsoft.AspNetCore.Hosting.IWebHostEnvironment used to select the DiGi.Communication.WebAPI base URI.
Executes the communication calculation for the antennas placed in the 3D view.
The buildings of the analyzed area are fetched and converted on the fly (Building -> Mesh3D -> ScatteringObject), packaged together with the antennas into a DiGi.Communication.Classes.GeometricalPropagationModel and sent to the GIS agnostic DiGi.Communication.WebAPI service; nothing is persisted.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> CalculateAsync(DiGi.GIS.WebAPI.UI.Classes.CommunicationCalculationParameter? communicationCalculationParameter, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));communicationCalculationParameter CommunicationCalculationParameter
The analyzed circular area and the antennas placed by the user.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> holding the calculation result JSON (currently the connecting DiGi.Geometry.Spatial.Classes.Segment3D and its length).
CommunicationController.CalculateAsyncV1(CommunicationCalculationParameter, CancellationToken) Method
[TEMPORARY A/B TESTING] Version 1 (current implementation) of the communication calculation.
The buildings of the analyzed area are fetched as DiGi.Analytical.Building.Classes.BuildingModel instances and converted to DiGi.Communication.Classes.ScatteringObject instances, packaged together with the antennas into a DiGi.Communication.Classes.GeometricalPropagationModel and solved in process (DiGi.Communication.Classes.ScatteringSolver + DiGi.Communication.Classes.AngularPowerDistributionSolver); nothing is persisted.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> CalculateAsyncV1(DiGi.GIS.WebAPI.UI.Classes.CommunicationCalculationParameter? communicationCalculationParameter, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));communicationCalculationParameter CommunicationCalculationParameter
The analyzed circular area and the antennas placed by the user.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> holding the calculation result JSON grouped by delay (ascending): the propagation ellipsoids, the scattering polylines (one per DiGi.Communication.Classes.ScatteringPointGroup) and the angular power distribution vectors, all in world coordinates.
CommunicationController.CalculateAsyncV2(CommunicationCalculationParameter, CancellationToken) Method
[TEMPORARY A/B TESTING] Version 2 (new implementation) of the communication calculation. Starts as a full self-contained copy of CalculateAsync(CommunicationCalculationParameter, CancellationToken); replace the body below with the new V2 algorithm.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> CalculateAsyncV2(DiGi.GIS.WebAPI.UI.Classes.CommunicationCalculationParameter? communicationCalculationParameter, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));communicationCalculationParameter CommunicationCalculationParameter
The analyzed circular area and the antennas placed by the user.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> holding the calculation result JSON.
Renders the communication 3D scene view for all buildings within the specified circular area (streamed as a binary glTF payload from the existing glb endpoint) together with the antenna toolbar.
public Microsoft.AspNetCore.Mvc.IActionResult GetBuildingsByRadius(double centerX, double centerY, double radius, System.Nullable<double> storeyHeight=null);centerX System.Double
The X coordinate of the center of the analyzed circular area.
centerY System.Double
The Y coordinate of the center of the analyzed circular area.
radius System.Double
The radius of the analyzed circular area in meters.
storeyHeight System.Nullable<System.Double>
The optional storey height in meters used for the building extrusions.
Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult rendering the communication scene view.
[TEMPORARY A/B TESTING] Renders the communication 3D scene view (version 1) wired to the v1 calculation endpoint.
public Microsoft.AspNetCore.Mvc.IActionResult GetBuildingsByRadiusV1(double centerX, double centerY, double radius, System.Nullable<double> storeyHeight=null);centerX System.Double
The X coordinate of the center of the analyzed circular area.
centerY System.Double
The Y coordinate of the center of the analyzed circular area.
radius System.Double
The radius of the analyzed circular area in meters.
storeyHeight System.Nullable<System.Double>
The optional storey height in meters used for the building extrusions.
Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult rendering the communication scene view for version 1.
[TEMPORARY A/B TESTING] Renders the communication 3D scene view (version 2) wired to the v2 calculation endpoint.
public Microsoft.AspNetCore.Mvc.IActionResult GetBuildingsByRadiusV2(double centerX, double centerY, double radius, System.Nullable<double> storeyHeight=null);centerX System.Double
The X coordinate of the center of the analyzed circular area.
centerY System.Double
The Y coordinate of the center of the analyzed circular area.
radius System.Double
The radius of the analyzed circular area in meters.
storeyHeight System.Nullable<System.Double>
The optional storey height in meters used for the building extrusions.
Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult rendering the communication scene view for version 2.
Initializes and returns the start view of the communication analysis feature.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result that renders the starting view.
Provides controller endpoints for accessing and managing EPW file data.
public class EPWFileController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → EPWFileController
Initializes a new instance of the EPWFileController class.
public EPWFileController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The HTTP client factory.
Asynchronously retrieves an EPW file based on the specified coordinates.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetEPWFileAsync(double x, double y);The X coordinate (longitude).
The Y coordinate (latitude).
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult representing the HTTP response.
Returns the starting view.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult representing the start view.
Controller responsible for handling requests related to heat transfer coefficients, providing data based on year or building reference.
public class HeatTransferCoefficientController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → HeatTransferCoefficientController
Initializes a new instance of the HeatTransferCoefficientController class.
public HeatTransferCoefficientController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The HTTP client factory used to create clients for external API communication.
HeatTransferCoefficientController.GetRegulatedHeatTransferCoefficientsByReferenceAsync(string, Nullable<int>) Method
Retrieves regulated heat transfer coefficients for a building identified by its reference, determining the applicable year based on the building's construction data.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetRegulatedHeatTransferCoefficientsByReferenceAsync(string reference, System.Nullable<int> countyId);reference System.String
The unique reference string of the building.
countyId System.Nullable<System.Int32>
The optional identifier for the county associated with the building.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult containing a partial view with the coefficient data, or an error result if the request fails.
HeatTransferCoefficientController.GetRegulatedHeatTransferCoefficientsByYearAsync(short, CancellationToken) Method
Retrieves regulated heat transfer coefficients for a specific year and returns them via a partial view.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetRegulatedHeatTransferCoefficientsByYearAsync(short year, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));year System.Int16
The calendar year used to filter the regulated heat transfer coefficients.
cancellationToken System.Threading.CancellationToken
A token to monitor for cancellation requests.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult containing a partial view with the coefficient data, or an error result if the request fails.
Provides the controller logic for handling requests to the home page of the GIS WebAPI user interface.
public class HomeController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → HomeController
Handles the request for the start page and returns the corresponding view.
public HomeController();Returns the view for the About page.
public Microsoft.AspNetCore.Mvc.IActionResult About();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result.
Returns the view for the Start page.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result.
Controller responsible for handling requests related to occupancy data for 2D buildings.
public class OccupancyDataController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → OccupancyDataController
Initializes a new instance of the OccupancyDataController class.
public OccupancyDataController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The HTTP client factory used to create clients for external API communication.
Retrieves the occupancy data and building reference for a specific 2D building item by its reference identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuilding2DItemByIdAsync(string reference, System.Nullable<int> countyId, System.Nullable<bool> isResidential);reference System.String
The unique reference string of the building.
countyId System.Nullable<System.Int32>
The optional ID of the county associated with the building.
isResidential System.Nullable<System.Boolean>
An optional flag indicating whether the building is residential.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult, which returns a partial view containing the occupancy data if successful; otherwise, a bad request or no content response.
Controller providing endpoints for managing and retrieving orthodata and coverage factor information.
public class OrtoDatasController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → OrtoDatasController
Initializes a new instance of the OrtoDatasController class.
public OrtoDatasController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The HTTP client factory used to create System.Net.Http.HttpClient instances.
Retrieves the estimated coverage factor for a specific administrative area L2D identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetEstimatedCoverageFactorAsync(int administrativeAreal2DId);administrativeAreal2DId System.Int32
The unique identifier of the administrative area L2D.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult with the coverage factor or error status.
Retrieves estimated coverage factors for a collection of administrative area L2D identifiers.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetEstimatedCoverageFactorsAsync(System.Collections.Generic.IEnumerable<int> administrativeAreal2DIds);administrativeAreal2DIds System.Collections.Generic.IEnumerable<System.Int32>
An enumerable collection of administrative area L2D identifiers.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult with the list of coverage factor values or error status.
Retrieves orthodata and building 2D reference information based on a provided reference and optional county ID.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByIdAsync(string reference, System.Nullable<int> countyId);reference System.String
The unique reference string for the item.
countyId System.Nullable<System.Int32>
The optional identifier for the county.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult representing the partial view or error response.
[TEMPORARY] Solar calculations for the 3D viewer Lighting panel, hosted locally until a DiGi.Solar backed endpoint is available on the central GIS Web API. The route contract (solar/sundirection) is final - when the central endpoint exists this controller becomes a proxy like the other controllers in this project, and the consuming frontend (gltf-viewer.js) stays unchanged.
public class SolarController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → SolarController
Calculates the sun position for a world location and a local date and time.
public Microsoft.AspNetCore.Mvc.IActionResult GetSunDirection(double x, double y, string? date, double hour);The X coordinate in the EPSG:2180 coordinate system [m].
The Y coordinate in the EPSG:2180 coordinate system [m].
date System.String
The local calendar date in the yyyy-MM-dd format.
hour System.Double
The local time of day as a decimal hour in the 0-24 range.
Microsoft.AspNetCore.Mvc.IActionResult
JSON with the true solar angles: azimuth [deg] (0 = north, clockwise) and altitude [deg] above the horizon (negative at night).
Provides API endpoints for retrieving and managing year built data.
public class YearBuiltDataController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → YearBuiltDataController
Initializes a new instance of the YearBuiltDataController class.
public YearBuiltDataController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create HTTP clients.
Retrieves a year built data item based on the specified reference and optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByReferenceAsync(string reference, System.Nullable<int> countyId);reference System.String
The unique reference of the item to retrieve.
countyId System.Nullable<System.Int32>
The optional identifier of the county associated with the item.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation, containing an Microsoft.AspNetCore.Mvc.IActionResult result.