/// <summary>
/// Verifies that <paramref name="actualQty"/> equals <paramref name="expectedQty"/>.
/// </summary>
/// <param name="actualQty"></param>
/// <param name="expectedQty"></param>
/// <returns>The <paramref name="actualQty"/>.</returns>
public static IQuantity Verify(this IQuantity actualQty, IQuantity expectedQty)
{
Assert.That(actualQty, Is.Not.Null);
Assert.That(expectedQty, Is.Not.Null);
Assert.That(expectedQty, Is.Not.SameAs(actualQty));
Assert.That(actualQty.Equals(expectedQty), "Expected {{{0}}} but was {{{1}}}",
expectedQty, actualQty);
return(actualQty);
}
/// <summary>
/// Example stepping through the structure of the
/// ResultData object
/// </summary>
/// <param name="resultFilepath">Path to a result file</param>
public static void FirstExample(string resultFilepath)
{
// load a result file
IResultData resultData = new ResultData();
resultData.Connection = Connection.Create(resultFilepath);
Diagnostics resultDiagnostics = new Diagnostics("Example");
resultData.Load(resultDiagnostics);
if (resultDiagnostics.ErrorCountRecursive > 0)
{
// Do some error reporting
throw new Exception("File could not be loaded");
}
// Time definition of the time step stored
int numtimesteps = resultData.NumberOfTimeSteps;
DateTime startTime = resultData.StartTime;
DateTime endTime = resultData.EndTime;
// times for all timesteps
IListDateTimes times = resultData.TimesList;
// Results are stored in DataItem’s, where one DataItem contains e.g. water level.
// Nodes, Reaches, Catchments and GlobalData of the resultData object will have a
// number of data items.
// A data item will store data for a number of elements and for a number
// of time steps.
// In reaches there will be more than one "element", since a reach will store
// data for several grid points. Nodes and catchments will always only have
// one element per data item
IRes1DNodes nodes = resultData.Nodes;
IRes1DReaches reaches = resultData.Reaches;
IRes1DCatchments catchments = resultData.Catchments;
IRes1DGlobalData globals = resultData.GlobalData;
// Generic loop over catchments/nodes/reaches (just replace catchments with nodes)
foreach (IRes1DDataSet dataSet in catchments)
{
// Each dataset has a number of data items
IDataItems dataItems = dataSet.DataItems;
// Loop over all data items
foreach (IDataItem dataItem in dataItems)
{
// A dataitem contains data for one quantity
IQuantity quantity = dataItem.Quantity;
// You can check the type of quantity in the data item
if (quantity.Equals(Quantity.Create(PredefinedQuantity.WaterLevel)))
{
}
}
}
// The example will now show how to extract data from a reach.
// Get the first reach in the list of reaches
IRes1DReach reach = reaches[0];
// Extract first data item for reach (there will be more than one)
// For a HD result file, this will be a water level.
IDataItem wlDataItem = reach.DataItems[0];
// Take data for all elements (subset of grid points) for the initial time step
// For water level quantity: One value for each H-grid point
float[] wlValues = wlDataItem.TimeData.GetValues(0);
// For a reach, if the IndexList is defined (not null), this
// gives the relation to the grid point where the values in
// a data item belongs to.
// For each value in the data item, it indicates the index of the grid point
// it belongs to, i.e. the size matches the number of elements in the data item.
// i.g. for water level: 0, 2, 4, 6, 8,...
// and for discharge : 1, 3, 5, 7,...
// The IndexList can be null, in which case information on the geometry of the
// data in the data item exist in the element set
int[] indexList = wlDataItem.IndexList;
// Loop over all elements (subset of grid points) in the data item
for (int i = 0; i < wlDataItem.NumberOfElements; i++)
{
// Time series values for this element (grid point)
float[] wlDataForElement = wlDataItem.CreateTimeSeriesData(i);
// Check if there is a grid-point relation
if (indexList != null)
{
// Index of grid point in list of grid opints
int gridPointIndex = wlDataItem.IndexList[i];
// Grid point where values belong to.
IRes1DGridPoint gridPoint = reach.GridPoints[gridPointIndex];
// More detailed information exist in the derived grid point classes
if (gridPoint is IRes1DHGridPoint)
{
IRes1DHGridPoint hGridPoint = gridPoint as IRes1DHGridPoint;
// An H-grid point also has a cross section.
IRes1DCrossSection crossSection = hGridPoint.CrossSection;
// More detailed information on the cross section exist in the derived types
if (crossSection is IRes1DOpenCrossSection)
{
// The open cross section has all the raw points and cross section markers
IRes1DOpenCrossSection openXs = crossSection as IRes1DOpenCrossSection;
IRes1DCrossSectionPoint lowestXsPoint = openXs.Points[openXs.LowestPoint];
}
}
}
}
}
