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>
].
{info}

h2. Create a new importer class

Add to the plugin project a&nbsp;new folder named _Importers_. In this folder, create a new class named _WaterML2TimeSeriesImporter.cs_ and adapt the contents as shown below:

{code}
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
    /// </summary>
    public class WaterML2TimeSeriesImporter : IFileImporter
    {
        private static readonly ILog Log = LogManager.GetLogger(typeof(WaterML2TimeSeriesImporter)); // Handle for writing log messages

        /// <summary>
        /// The name of the importer
        /// </summary>
        /// <remarks>UsedImporter in importerfor selection dialogs</remarks>
     importing WaterML2 data to time series objects
   public string Name/// </summary>
    public class WaterML2TimeSeriesImporter : {IFileImporter
    {
        getprivate {static returnreadonly "WaterML2ILog timeLog series importer"; }
        }= LogManager.GetLogger(typeof(WaterML2TimeSeriesImporter)); // Handle for writing log messages

        /// <summary>
        /// The categoryname of the importer
        /// </summary>
        /// <remarks>Used in importer selection dialogs</remarks>
        public string CategoryName
        {
            get { return "VolumeWaterML2 time modelseries importersimporter"; }
        }

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

        /// <summary>
        /// The data types supported by the importer image of the importer
        /// </summary>
        /// </summary><remarks>Used in importer selection dialogs</remarks>
        public IEnumerable<Type>Bitmap SupportedItemTypesImage
        {
            get { yieldreturn returnnew typeof(TimeSeriesBitmap(16, 16); }
        }

        /// <summary>
        /// IndicatesThe thatdata thetypes importer can import at root level (folder/project). In othersupported by the importer
        /// words, indicates that the <see cref="ImportItem"/> method can be called without</summary>
        public IEnumerable<Type> SupportedItemTypes
        {
        /// specifying a time series target...    get { yield return typeof(TimeSeries); }
        /// </summary>}

        public bool CanImportOnRootLevel/// <summary>
        {
/// Indicates that the importer can import at root level (folder/project). In get {other
 return true; }
      /// words, }

indicates that the <see cref="ImportItem"/> method can be ///called <summary>without
        /// Thespecifying filea filtertime of the importerseries target...
        /// </summary>
/summary>
        public bool CanImportOnRootLevel
        {
 /// <remarks>Used in file selection dialogs</remarks>
      get { publicreturn stringtrue; FileFilter}
        {}

        /// <summary>
   get { return "WaterML2 files|*.XML"; }
        }
 /// The file filter of the importer
        /// <summary></summary>
        /// Path where external data files can be copied into<remarks>Used in file selection dialogs</remarks>
        public string FileFilter
        /// </summary>{
        /// <remarks>Not relevant in this tutorial</remarks>
     get { return "WaterML2 files|*.XML"; }
   public string TargetDataDirectory { get; set; }

        /// <summary>
        /// WhetherPath orwhere notexternal andata importfiles taskcan shouldbe becopied cancelledinto
        /// </summary>
        /// <remarks>Not partrelevant ofin this tutorial</remarks>
        public boolstring ShouldCancelTargetDataDirectory { get; set; }

        /// <summary>
        /// Fired when progress has been changedWhether or not an import task should be cancelled
        /// </summary>
        /// <remarks>Not part inof this tutorial</remarks>
        public ImportProgressChangedDelegatebool ProgressChangedShouldCancel { get; set; }

        /// <summary>
        /// ImportsFired WaterML2when dataprogress from the file with path <paramref name="path"/> to the
        /// time series <paramref name="target"/>has been changed
        /// </summary>
        /// <remarks>
<remarks>Not part in this tutorial</remarks>
        public ImportProgressChangedDelegate ///ProgressChanged The{ targetget; parameter is optional. If a target time series is specified, theset; }

        /// <summary>
        /// importerImports WaterML2 shoulddata importfrom the WaterML2file datawith topath this existing time series. When<paramref name="path"/> to the
        /// time series no<paramref name="target"/>
 is set, the importer should create a new time series./// </summary>
        /// </remarks><remarks>
        public object ImportItem(string path, object/// The target parameter is optional. If a target =time null)
series is specified, the
     {
   /// importer should import the WaterML2 data to this // Check the file pathexisting time series. When
        //  no target is if (!File.Exists(path))
       set, the importer should create a new time series.
     {
   /// </remarks>
        public object ImportItem(string  Log.Error("File does not exist");

path, object target = null)
        {
         return null;
       // Check the file path
        }

    if (!File.Exists(path))
       // Obtain a new time series{
 or check the provided target for being a time series
      Log.Error("File does not exist");

   var timeSeries = target == null
        return null;
       ? new TimeSeries { Name = Path.GetFileNameWithoutExtension(path), Components = { new Variable<double>() } }
}

            // Obtain a new time series or check the provided target for :being targeta astime TimeSeries;
series
            ifvar (timeSeries = target == null)
            {
    ? new TimeSeries { Name = Path.GetFileNameWithoutExtension(path), Components = { new Variable<double>() }  Log.Error("Target is of the wrong type (should be time series)");

}
                : target as TimeSeries;

       return null;
    if (timeSeries == null)
     }

       {
     // Load the WaterML2 XML document
      Log.Error("Target is of the wrong type var(should docbe = XDocument.Load(pathtime series)");

             // Obtain the documentreturn elementsnull;
            var xElements = doc.Descendants();}

            // ObtainLoad the measurementWaterML2 TVPXML tagsdocument
            var measurements = xElements.Where(element => element.Name.LocalName == "MeasurementTVP"   var doc = XDocument.Load(path);

            // GetObtain the corresponding time and value for each measurement tagdocument elements
            foreach (var measurementxElements in measurements)= doc.Descendants();

            {
    // Obtain the measurement TVP tags
            var timemeasurements = DateTimexElements.Parse(measurement.Elements().First(eWhere(element => eelement.Name.LocalName == "timeMeasurementTVP").Value);

            // Get the corresponding vartime and value = double.Parse(measurement.Elements().First(e => e.Name.LocalName == "value").Value);

      for each measurement tag
            foreach (var measurement in measurements)
          timeSeries[time] = value;{
            }

    var time = DateTime.Parse(measurement.Elements().First(e => e.Name.LocalName     // Return the time series== "time").Value);
            return timeSeries;
   var value =   }
    }
}
{code}

{note}
In order to successfully build the code, 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_)_._
{note}
{info}



The importer class is derived from the _IFileImporter_ interface so that it can be registered in the application plugin (see the next step).

The comments in the code explain the different parts of the importer implementation.
{info}



h2. Register the importer in the application plugin class

Register the importer in the application plugin by adding the following code to _VolumeModelApplicationPlugin.cs_:

{code}double.Parse(measurement.Elements().First(e => e.Name.LocalName == "value").Value);

                timeSeries[time] = value;
            }

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

The importer class is derived from the IFileImporter interface so that it can be registered in the application plugin (see the next step).

The comments in the code explain the different parts of the importer implementation.

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

Importers;
{code}

and

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