// Copyright (C) Stichting Deltares 2016. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.
using System;
using System.Collections.Generic;
using System.Linq;
using Core.Common.Base.Data;
using Core.Common.Base.Geometry;
using Core.Common.Geometry;
using Core.Components.Gis.Data;
using Core.Components.Gis.Features;
using Core.Components.Gis.Geometries;
using Ringtoets.Common.Data;
using Ringtoets.Common.Data.AssessmentSection;
using Ringtoets.Common.Data.DikeProfiles;
using Ringtoets.Common.Data.FailureMechanism;
using Ringtoets.Common.Data.Hydraulics;
using Ringtoets.Common.Data.Structures;
using Ringtoets.Common.Forms.PresentationObjects;
using Ringtoets.Common.Forms.Properties;
namespace Ringtoets.Common.Forms.Views
{
///
/// Factory for creating arrays of to use in
/// (created via ).
///
public static class RingtoetsMapDataFeaturesFactory
{
///
/// Create a single representing a single line.
///
/// The world map points describing the line.
/// The created map feature.
/// Thrown when
/// is null.
public static MapFeature CreateSingleLineMapFeature(IEnumerable points)
{
if (points == null)
{
throw new ArgumentNullException(nameof(points));
}
return new MapFeature(new[]
{
new MapGeometry(new[]
{
points
})
});
}
///
/// Create reference line features based on the provided .
///
/// The to create the reference
/// line features for.
/// The id of the .
/// The name of the .
/// An array of features or an empty array when
/// is null.
public static MapFeature[] CreateReferenceLineFeatures(ReferenceLine referenceLine, string id, string name)
{
if (referenceLine != null)
{
MapFeature feature = CreateSingleLineMapFeature(referenceLine.Points);
feature.MetaData[Resources.MetaData_ID] = id;
feature.MetaData[Resources.MetaData_Name] = name;
feature.MetaData[Resources.MetaData_Length] = new RoundedDouble(2, Math2D.Length(referenceLine.Points));
return new[]
{
feature
};
}
return new MapFeature[0];
}
///
/// Create hydraulic boundary database location features based on the provided .
///
/// The
/// to create the location features for.
/// An array of features or an empty array when
/// is null.
public static MapFeature[] CreateHydraulicBoundaryDatabaseFeatures(HydraulicBoundaryDatabase hydraulicBoundaryDatabase)
{
return CreateHydraulicBoundaryLocationFeatures(hydraulicBoundaryDatabase?.Locations.ToArray() ?? new HydraulicBoundaryLocation[0],
Resources.MetaData_DesignWaterLevel,
Resources.MetaData_WaveHeight);
}
///
/// Create hydraulic boundary location features based on the provided .
///
/// The locations to create the features for.
/// The name of the design water level attribute.
/// The name of the wave height attribute.
/// An array of features or an empty array when
/// is empty.
/// Thrown when any input parameter is null.
public static MapFeature[] CreateHydraulicBoundaryLocationFeatures(HydraulicBoundaryLocation[] hydraulicBoundaryLocations,
string designWaterLevelAttributeName,
string waveHeightAttributeName)
{
if (hydraulicBoundaryLocations == null)
{
throw new ArgumentNullException(nameof(hydraulicBoundaryLocations));
}
if (designWaterLevelAttributeName == null)
{
throw new ArgumentNullException(nameof(designWaterLevelAttributeName));
}
if (waveHeightAttributeName == null)
{
throw new ArgumentNullException(nameof(waveHeightAttributeName));
}
var features = new MapFeature[hydraulicBoundaryLocations.Length];
for (var i = 0; i < hydraulicBoundaryLocations.Length; i++)
{
HydraulicBoundaryLocation location = hydraulicBoundaryLocations[i];
MapFeature feature = CreateSinglePointMapFeature(location.Location);
feature.MetaData[Resources.MetaData_ID] = location.Id;
feature.MetaData[Resources.MetaData_Name] = location.Name;
feature.MetaData[designWaterLevelAttributeName] = location.DesignWaterLevel;
feature.MetaData[waveHeightAttributeName] = location.WaveHeight;
features[i] = feature;
}
return features;
}
///
/// Create section features based on the provided .
///
/// The collection of to create
/// the section features for.
/// An array of features or an empty array when is
/// null or empty.
public static MapFeature[] CreateFailureMechanismSectionFeatures(IEnumerable sections)
{
return sections?.Select(CreateFailureMechanismSectionMapFeature).ToArray() ?? new MapFeature[0];
}
///
/// Create section start point features based on the provided .
///
/// The collection of to create
/// the section start point features for.
/// An array of features or an empty array when is
/// null or empty.
public static MapFeature[] CreateFailureMechanismSectionStartPointFeatures(IEnumerable sections)
{
return sections != null && sections.Any()
? new[]
{
CreateSingleLineMapFeature(sections.Select(sl => sl.GetStart()))
}
: new MapFeature[0];
}
///
/// Create section end point features based on the provided .
///
/// The collection of to create
/// the section end point features for.
/// An array of features or an empty array when is
/// null or empty.
public static MapFeature[] CreateFailureMechanismSectionEndPointFeatures(IEnumerable sections)
{
return sections != null && sections.Any()
? new[]
{
CreateSingleLineMapFeature(sections.Select(sl => sl.GetLast()))
}
: new MapFeature[0];
}
///
/// Create features for the geometry of the .
///
/// The profiles to create features for.
/// An array of features or an empty array when is
/// null or empty.
public static MapFeature[] CreateDikeProfilesFeatures(IEnumerable dikeProfiles)
{
if (dikeProfiles != null)
{
int nrOfElements = dikeProfiles.Count();
var mapFeatures = new MapFeature[nrOfElements];
var i = 0;
foreach (DikeProfile dikeProfile in dikeProfiles)
{
MapFeature feature = CreateSingleLineMapFeature(GetWorldPoints(dikeProfile));
feature.MetaData[Resources.MetaData_Name] = dikeProfile.Name;
mapFeatures[i] = feature;
i++;
}
return mapFeatures;
}
return new MapFeature[0];
}
///
/// Create features for the geometry of the .
///
/// The profiles to create features for.
/// An array of features or an empty array when
/// is null or empty.
public static MapFeature[] CreateForeshoreProfilesFeatures(IEnumerable foreshoreProfiles)
{
if (foreshoreProfiles != null)
{
ForeshoreProfile[] foreShoreProfilesWithGeometry = foreshoreProfiles.Where(fp => fp.Geometry != null && fp.Geometry.Any()).ToArray();
int nrOfElements = foreShoreProfilesWithGeometry.Length;
var mapFeatures = new MapFeature[nrOfElements];
for (var i = 0; i < nrOfElements; i++)
{
ForeshoreProfile foreshoreProfile = foreShoreProfilesWithGeometry[i];
MapFeature feature = CreateSingleLineMapFeature(GetWorldPoints(foreshoreProfile));
feature.MetaData[Resources.MetaData_Name] = foreshoreProfile.Name;
mapFeatures[i] = feature;
}
return mapFeatures;
}
return new MapFeature[0];
}
///
/// Create features for the geometry of the .
///
/// The profiles to create features for.
/// An array of features or an empty array when is
/// null or empty.
public static MapFeature[] CreateStructuresFeatures(IEnumerable structures)
{
if (structures != null)
{
int nrOfElements = structures.Count();
var mapFeatures = new MapFeature[nrOfElements];
var i = 0;
foreach (StructureBase structure in structures)
{
MapFeature feature = CreateSinglePointMapFeature(structure.Location);
feature.MetaData[Resources.MetaData_Name] = structure.Name;
mapFeatures[i] = feature;
i++;
}
return mapFeatures;
}
return new MapFeature[0];
}
///
/// Create calculation features based on the provided .
///
/// The collection of to create the
/// calculation features for.
/// An array of features or an empty array when is null
/// or empty.
public static MapFeature[] CreateStructureCalculationsFeatures(IEnumerable> calculations)
where T : StructuresInputBase, new()
where U : StructureBase
{
if (calculations != null && calculations.Any())
{
MapCalculationData[] calculationData = calculations.Where(CalculationHasStructureAndHydraulicBoundaryLocation)
.Select(CreatemapCalculationData).ToArray();
return CreateCalculationFeatures(calculationData);
}
return new MapFeature[0];
}
///
/// Create calculation features based on the provided .
///
/// The collection of to create the
/// calculation features for.
/// An array of features or an empty array when is null
/// or empty.
public static MapFeature[] CreateCalculationFeatures(MapCalculationData[] calculationData)
{
if (calculationData != null && calculationData.Any())
{
var features = new MapFeature[calculationData.Length];
for (var i = 0; i < calculationData.Length; i++)
{
MapCalculationData calculationItem = calculationData[i];
MapFeature feature = CreateSingleLineMapFeature(new[]
{
calculationItem.CalculationLocation,
calculationItem.HydraulicBoundaryLocation.Location
});
feature.MetaData[Resources.MetaData_Name] = calculationItem.Name;
feature.MetaData[Resources.MetaData_Couple_distance] =
calculationItem.CalculationLocation.GetEuclideanDistanceTo(
calculationItem.HydraulicBoundaryLocation.Location);
features[i] = feature;
}
return features;
}
return new MapFeature[0];
}
///
/// Creates a map feature with one single point.
///
/// The point of the map feature.
/// The map feature with the as geometry.
/// Thrown when is null.
public static MapFeature CreateSinglePointMapFeature(Point2D point)
{
if (point == null)
{
throw new ArgumentNullException(nameof(point));
}
return new MapFeature(new[]
{
new MapGeometry(new[]
{
new[]
{
point
}
})
});
}
private static MapCalculationData CreatemapCalculationData(StructuresCalculation calculation)
where T : StructuresInputBase, new()
where U : StructureBase
{
return new MapCalculationData(
calculation.Name,
calculation.InputParameters.Structure.Location,
calculation.InputParameters.HydraulicBoundaryLocation);
}
private static bool CalculationHasStructureAndHydraulicBoundaryLocation(StructuresCalculation calculation)
where T : StructuresInputBase, new()
where U : StructureBase
{
return calculation.InputParameters.Structure != null &&
calculation.InputParameters.HydraulicBoundaryLocation != null;
}
private static MapFeature CreateFailureMechanismSectionMapFeature(FailureMechanismSection section)
{
var feature = new MapFeature(new[]
{
new MapGeometry(new[]
{
section.Points.Select(p => new Point2D(p.X, p.Y))
})
});
feature.MetaData[Resources.MetaData_Name] = section.Name;
feature.MetaData[Resources.MetaData_Length] = new RoundedDouble(2, Math2D.Length(section.Points));
return feature;
}
private static Point2D[] GetWorldPoints(DikeProfile dikeProfile)
{
return AdvancedMath2D.FromXToXY(
dikeProfile.DikeGeometry.Select(p => -p.Point.X).ToArray(),
dikeProfile.WorldReferencePoint,
-dikeProfile.X0,
dikeProfile.Orientation);
}
private static Point2D[] GetWorldPoints(ForeshoreProfile foreshoreProfile)
{
return AdvancedMath2D.FromXToXY(
foreshoreProfile.Geometry.Select(p => -p.X).ToArray(),
foreshoreProfile.WorldReferencePoint,
-foreshoreProfile.X0,
foreshoreProfile.Orientation);
}
}
}