Page History

In order to successfully build the code below, references need to be added to:

• log4net (right click the References folder of the project in the Solution Explorer | Add Reference... | Browse... | Select D:\VolumeModel\packages\DeltaShell.1.0.0\delta-shell\bin\log4net.dll);
• System.Drawing (right click the References folder of the project in the Solution Explorer | Add Reference... | Assemblies | Framework | Select System.Drawing).

using System;
using System.Collections.Generic;
using System.Drawing;
using System.IO;
using System.Linq;
using System.Xml.Linq;
using DelftTools.Functions;
using DelftTools.Functions.Generic;
using DelftTools.Shell.Core;
using log4net;

namespace DeltaShell.Plugins.VolumeModel.Importers
{
    /// <summary>
    /// Importer for importing WaterML2 data to time series objects

using System;
using System.Collections.Generic;
using System.Drawing;
using System.IO;
using System.Linq;
using System.Xml.Linq;
using DelftTools.Functions;
using DelftTools.Functions.Generic;
using DelftTools.Shell.Core;
using log4net;

namespace DeltaShell.Plugin.DemoApp.Importers
{
    public class WaterML2TimeSeriesImporter : IFileImporter
    {
        private static readonly ILog log = LogManager.GetLogger(typeof(WaterML2TimeSeriesImporter));

        /// <summary></summary>
    public class WaterML2TimeSeriesImporter : ///IFileImporter
 The name of the importer{
        /// </summary>
        public string Name
  private static readonly ILog Log = LogManager.GetLogger(typeof(WaterML2TimeSeriesImporter)); // Handle for writing log messages

      {
  /// <summary>
        /// getThe {name return "WaterML2 time series importer"; }
of the importer
         }

/// </summary>
        /// <summary>
        /// The category of the importer
        /// </summary><remarks>Used in importer selection dialogs</remarks>
        public string CategoryName
        {
            get { return "DemoApp importersWaterML2 time series importer"; }
        }

        /// <summary>
        /// The imagecategory of the importer
        /// </summary>
        public/// Bitmap<remarks>Used Image
in importer   selection dialogs</remarks>
        public string Category
        {
            get { return new Bitmap(16, 16);"Volume model importers"; }
        }

        /// <summary>
        /// The dataimage types supportedof by the importer
        /// </summary>
        public/// IEnumerable<Type><remarks>Used SupportedItemTypes
in importer selection dialogs</remarks>
     {
   public Bitmap Image
        {
            get { yieldreturn returnnew typeof(TimeSeriesBitmap(16, 16); }
        }

        /// <summary>
        /// IndicatesThe data whethertypes orsupported notby the importer
 can    import at root level (folder/project)./// </summary>
        /// If true, the importer will always show up in the project->import list. If
public IEnumerable<Type> SupportedItemTypes
        {
            ///get false{ thisyield importer can only be retrieved by supported type, eg, in code.return typeof(TimeSeries); }
        }

        /// <summary>
 Use false for partial/composite importers and importers called from map tools
        /// etc.Indicates Ifthat true, the importer iscan assumedimport toat supportroot both "new" and "into" modes.level (folder/project). In other
        /// </summary>
        public bool CanImportOnRootLevelwords, indicates that the <see cref="ImportItem"/> method can be called without
        {
/// specifying a time series target...
       get { return true; }
/// </summary>
        public bool }CanImportOnRootLevel

        /// <summary>{
            get { return true; }
        }

        /// <summary>
        /// The file filter of the importer
        /// </summary>
        /// <remarks>Used <example>"Myin file format1 (*.ext1)|*.ext1|My file format2 (*.ext2)|*.ext2"</example>selection dialogs</remarks>
        public string FileFilter
        {
            get { return "WaterML2 files|*.XML"; }
        }

        /// <summary>
        /// Path where external data files can be copied into
        /// </summary>
        /// <remarks>Optional,<remarks>Not usedrelevant onlyin when external files need to be copied into the project "as is"</remarks> 
        public string TargetDataDirectory { this tutorial</remarks>
        public string TargetDataDirectory { get; set; }

        /// <summary>
        /// Whether or not an import task should be cancelled
        /// </summary>
        /// <remarks>This<remarks>Not propertypart mustof be observed by the importer (thread-safe); when it is true the importer must stop current import task<this tutorial</remarks>
        public bool ShouldCancel { get; set; }

        /// <summary>
        /// Fired when progress has been changed
        /// </summary>
        /// <remarks>Not part in this tutorial</remarks>
        public ImportProgressChangedDelegate ProgressChanged { get; set; }

        /// <summary>
        /// Imports WaterML2 data from the file with path <paramref name="path"/> to target the
        /// time series <paramref name="target"/>
        /// </summary>
        /// <remarks>
        /// <remarks>TheThe target parameter is optional. If a target istime series is specified, the
        /// importer should import newthe WaterML2 data to this intoexisting thetime targetseries. IfWhen
        //  no target is specifiedset, the importer should import the data intocreate a new object.</remarks>time series.
        /// </remarks>
        public object ImportItem(string path, object target = null)
        {
            // Check the file path
            if (!File.Exists(path))
            {
                logLog.Error("File does not exist");

                return null;
            }

            // Obtain a new time series or check the provided target for being a time series
            var timeSeries = target == null
                ? new TimeSeries { Name = Path.GetFileNameWithoutExtension(path), Components = { new Variable<double>() } }
                : target as TimeSeries;

            if (timeSeries == null)
            {
                logLog.Error("Target is of the wrong type (should be time series)");

                return null;
            }

            // Load the WaterML2 XML document
            var doc = XDocument.Load(path);

            // Obtain the document elements
            var xElements = doc.Descendants();

            // Obtain the measurement TVP tags
            var measurements = xElements.Where(element => element.Name.LocalName == "MeasurementTVP");

            // Get the corresponding time and value for each measurement tag
            foreach (var measurement in measurements)
            {
                var time = DateTime.Parse(measurement.Elements().First(e => e.Name.LocalName == "time").Value);
                var value = double.Parse(measurement.Elements().First(e => e.Name.LocalName == "value").Value);

                timeSeries[time] = value;
            }

            // Return the time series
            return timeSeries;
        }
    }
}

using System.Collections.Generic;
using DeltaShell.Plugins.VolumeModel.Importers;

public override IEnumerable<IFileImporter> GetFileImporters()
{
    yield return new WaterML2TimeSeriesImporter();
}