Index: DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/SensorData.cs
===================================================================
diff -u -r1616 -r1619
--- DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/SensorData.cs (.../SensorData.cs) (revision 1616)
+++ DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/SensorData.cs (.../SensorData.cs) (revision 1619)
@@ -81,16 +81,31 @@
get { return sensorLocations; }
}
+ ///
+ /// Gets the sensor by identifier.
+ ///
+ /// The identifier.
+ ///
public Sensor GetSensorById(int id)
{
return sensors.FirstOrDefault(sensor => sensor.ID == id);
}
+ ///
+ /// Gets the group by identifier.
+ ///
+ /// The identifier.
+ ///
public SensorGroup GetGroupById(int id)
{
return sensorGroups.FirstOrDefault(sensorGroup => sensorGroup.ID == id);
}
+ ///
+ /// Gets the name of the sensor location by location.
+ ///
+ /// The name.
+ ///
public SensorLocation GetSensorLocationByLocationName(string name)
{
return sensorLocations.FirstOrDefault(sensorLocation => sensorLocation.LocationName == name);
Index: DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Sensor.cs
===================================================================
diff -u -r1617 -r1619
--- DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Sensor.cs (.../Sensor.cs) (revision 1617)
+++ DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Sensor.cs (.../Sensor.cs) (revision 1619)
@@ -56,20 +56,29 @@
private double yRd;
private double zRd;
+ ///
+ /// Initializes a new instance of the class.
+ ///
public Sensor()
{
plLineTypes = new HashSet();
ID = -1;
//geometry = new Point(0,0,0);
}
-// public Sensor(Point point) : this()
-// {
-// if (point == null) throw new ArgumentNullException("point");
-// //this.geometry = point;
-//
-// }
+ // public Sensor(Point point) : this()
+ // {
+ // if (point == null) throw new ArgumentNullException("point");
+ // //this.geometry = point;
+ //
+ // }
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The x.
+ /// The y.
+ /// The z.
public Sensor(double x, double y, double z) //: this(new Point(x, y, z))
{
xRd = x;
@@ -211,6 +220,12 @@
}
}
+ ///
+ /// Gets or sets the pl line mappings as string.
+ ///
+ ///
+ /// The pl line mappings as string.
+ ///
public string PlLineMappingsAsString
{
get
@@ -313,6 +328,12 @@
return ID < 0;
}
+ ///
+ /// Returns a that represents this instance.
+ ///
+ ///
+ /// A that represents this instance.
+ ///
public override string ToString()
{
var name = string.IsNullOrWhiteSpace(Name) ? "name_not_set" : Name;
Index: DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/SensorLocation.cs
===================================================================
diff -u -r1616 -r1619
--- DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/SensorLocation.cs (.../SensorLocation.cs) (revision 1616)
+++ DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/SensorLocation.cs (.../SensorLocation.cs) (revision 1619)
@@ -145,6 +145,10 @@
}
}
+ ///
+ /// Resets the group identifier.
+ ///
+ /// The identifier.
public void ResetGroupID(int id)
{
sensorGroup.ID = id;
@@ -266,21 +270,45 @@
}
}
+ ///
+ /// Gets the surface line.
+ ///
+ ///
+ /// The surface line.
+ ///
public SurfaceLine2 SurfaceLine
{
get { return Location.SurfaceLine; }
}
+ ///
+ /// Gets the river level.
+ ///
+ ///
+ /// The river level.
+ ///
public double RiverLevel
{
get { return Location.RiverLevel; }
}
+ ///
+ /// Gets the polder level.
+ ///
+ ///
+ /// The polder level.
+ ///
public double PolderLevel
{
get { return Location.PolderLevel; }
}
+ ///
+ /// Gets the head PL3.
+ ///
+ ///
+ /// The head PL3.
+ ///
public double? HeadPl3
{
get { return Location.HeadPl3; }
@@ -291,14 +319,32 @@
get { return Location.HeadPl4; }
}
+ ///
+ /// Gets or sets the alias.
+ ///
+ ///
+ /// The alias.
+ ///
public string Alias { get; set; } // ToDo Tom/Kin Sun Waarvoor nodig? Wordt nergens gebruikt. Kan gewoon weg!?
+ ///
+ /// Gets or sets the profile.
+ ///
+ ///
+ /// The profile.
+ ///
public string Profile
{
get; //{ return SoilProfile2D } ;
set;
}
+ ///
+ /// Gets or sets the m stab file.
+ ///
+ ///
+ /// The m stab file.
+ ///
public string MStabFile
{
get; //{ return SoilProfile2D } ;
@@ -372,6 +418,19 @@
internal static readonly string Pl4 = StaticReflection.GetMemberName(x => x.SourceTypePl4);
}
+ ///
+ /// Gets the value.
+ ///
+ /// The expression.
+ /// The sensor values.
+ /// The sensor.
+ ///
+ ///
+ /// sensorValues
+ /// or
+ /// sensor
+ ///
+ /// The given sensor is not an item/key in the table of sensor values
public double? GetValue(Expression> expression, IDictionary sensorValues, Sensor sensor)
{
if (sensorValues == null) throw new ArgumentNullException("sensorValues");
Index: DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/SensorRepository.cs
===================================================================
diff -u -r1616 -r1619
--- DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/SensorRepository.cs (.../SensorRepository.cs) (revision 1616)
+++ DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/SensorRepository.cs (.../SensorRepository.cs) (revision 1619)
@@ -25,6 +25,9 @@
namespace Deltares.DamEngine.Data.General.Sensors
{
+ ///
+ /// Class holding the repository for the sensors
+ ///
public class SensorRepository
{
private SensorLocation sensorLocation;
@@ -37,6 +40,10 @@
ids = new HashSet();
}
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The location.
public SensorRepository(Location location) : this()
{
if (location.SensorLocation == null)
@@ -50,16 +57,32 @@
sensorLocation.SensorGroup = new SensorGroup();
}
+ ///
+ /// Gets the sensor group.
+ ///
+ ///
+ /// The sensor group.
+ ///
internal SensorGroup SensorGroup
{
get { return sensorLocation.SensorGroup; }
}
+ ///
+ /// Gets the sensors.
+ ///
+ ///
+ /// The sensors.
+ ///
public IEnumerable Sensors
{
get { return SensorGroup.Selection; }
}
+ ///
+ /// Gets the unique sensor identifier.
+ ///
+ ///
internal int GetUniqueSensorId()
{
return SensorGroup.Selection.GetUniqueID(x => x.ID);
Index: DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Specifications/DitchWaterLevelSensorSpecification.cs
===================================================================
diff -u -r1617 -r1619
--- DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Specifications/DitchWaterLevelSensorSpecification.cs (.../DitchWaterLevelSensorSpecification.cs) (revision 1617)
+++ DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Specifications/DitchWaterLevelSensorSpecification.cs (.../DitchWaterLevelSensorSpecification.cs) (revision 1619)
@@ -23,18 +23,34 @@
namespace Deltares.DamEngine.Data.General.Sensors.Specifications
{
+ ///
+ /// Class holding the DitchWaterLevelSensorSpecification
+ ///
+ ///
public class DitchWaterLevelSensorSpecification : PredicateSpecification
{
private readonly double xDitchDikeSide;
private readonly double xDitchPolderSide;
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The x ditch dike side.
+ /// The x ditch polder side.
public DitchWaterLevelSensorSpecification(double xDitchDikeSide, double xDitchPolderSide) :
base(s => s.SensorType == SensorType.PolderLevel)
{
this.xDitchDikeSide = xDitchDikeSide;
this.xDitchPolderSide = xDitchPolderSide;
}
+ ///
+ /// Determines whether the candidate satisfies the specification.
+ ///
+ /// The candidate.
+ ///
+ /// true if the candidate satisfies the specification otherwise, false.
+ ///
public override bool IsSatisfiedBy(Sensor candidate)
{
if (base.IsSatisfiedBy(candidate))
Index: DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/SensorGroup.cs
===================================================================
diff -u -r1616 -r1619
--- DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/SensorGroup.cs (.../SensorGroup.cs) (revision 1616)
+++ DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/SensorGroup.cs (.../SensorGroup.cs) (revision 1619)
@@ -25,6 +25,9 @@
namespace Deltares.DamEngine.Data.General.Sensors
{
+ ///
+ /// Class for sensor group
+ ///
public class SensorGroup
{
///
@@ -39,6 +42,9 @@
///
private readonly IDictionary relativeLocationAlongProfileDictionary;
+ ///
+ /// Initializes a new instance of the class.
+ ///
public SensorGroup()
{
sensors = new HashSet();
@@ -147,11 +153,23 @@
get { return sensors.Count; }
}
+ ///
+ /// Gets the sensor relative locations.
+ ///
+ ///
+ /// The sensor relative locations.
+ ///
public IEnumerable> SensorRelativeLocations
{
get { return relativeLocationAlongProfileDictionary; }
}
+ ///
+ /// Gets or sets the pick sensors.
+ ///
+ ///
+ /// The pick sensors.
+ ///
public List PickSensors
{
get { return pickSensors; }
@@ -221,6 +239,12 @@
relativeLocationAlongProfileDictionary.Clear();
}
+ ///
+ /// Returns a that represents this instance.
+ ///
+ ///
+ /// A that represents this instance.
+ ///
public override string ToString()
{
return ID.ToString();
Index: DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Specifications/WaterLevelSensorSpecification.cs
===================================================================
diff -u -r1617 -r1619
--- DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Specifications/WaterLevelSensorSpecification.cs (.../WaterLevelSensorSpecification.cs) (revision 1617)
+++ DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Specifications/WaterLevelSensorSpecification.cs (.../WaterLevelSensorSpecification.cs) (revision 1619)
@@ -23,8 +23,15 @@
namespace Deltares.DamEngine.Data.General.Sensors.Specifications
{
+ ///
+ /// Class holding the WaterLevelSensorSpecification
+ ///
+ ///
public class WaterLevelSensorSpecification : PredicateSpecification
{
+ ///
+ /// Initializes a new instance of the class.
+ ///
public WaterLevelSensorSpecification() :
base(s => s.SensorType == SensorType.WaterLevel)
{
Index: DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Specifications/PiezometricHeadSensorSpecification.cs
===================================================================
diff -u -r1617 -r1619
--- DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Specifications/PiezometricHeadSensorSpecification.cs (.../PiezometricHeadSensorSpecification.cs) (revision 1617)
+++ DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Specifications/PiezometricHeadSensorSpecification.cs (.../PiezometricHeadSensorSpecification.cs) (revision 1619)
@@ -23,8 +23,15 @@
namespace Deltares.DamEngine.Data.General.Sensors.Specifications
{
- internal class PiezometricHeadSensorSpecification : PredicateSpecification
+ ///
+ /// Class holding the PiezometricHeadSensorSpecification
+ ///
+ ///
+ public class PiezometricHeadSensorSpecification : PredicateSpecification
{
+ ///
+ /// Initializes a new instance of the class.
+ ///
public PiezometricHeadSensorSpecification() :
base(s => s.SensorType == SensorType.PiezometricHead)
{
Index: DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Specifications/PolderLevelSensorSpecification.cs
===================================================================
diff -u -r1617 -r1619
--- DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Specifications/PolderLevelSensorSpecification.cs (.../PolderLevelSensorSpecification.cs) (revision 1617)
+++ DamEngine/trunk/src/Deltares.DamEngine.Data/General/Sensors/Specifications/PolderLevelSensorSpecification.cs (.../PolderLevelSensorSpecification.cs) (revision 1619)
@@ -23,8 +23,15 @@
namespace Deltares.DamEngine.Data.General.Sensors.Specifications
{
+ ///
+ /// Class holding the PolderLevelSensorSpecification
+ ///
+ ///
public class PolderLevelSensorSpecification : PredicateSpecification
{
+ ///
+ /// Initializes a new instance of the class.
+ ///
public PolderLevelSensorSpecification() :
base(s => s.SensorType == SensorType.PolderLevel)
{