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
    /// </summary>
    public class WaterML2TimeSeriesImporter : IFileImporter
    {

    public class WaterML2TimeSeriesImporter : IFileImporter
    {
        private static readonly ILog log = LogManager.GetLogger(typeof(WaterML2TimeSeriesImporter));

        public string Name
        {
            get { return "WaterML2 time series importer"; }
        }

        public string Category
        {
private static readonly ILog Log = LogManager.GetLogger(typeof(WaterML2TimeSeriesImporter)); // Handle for writing  get { return "DemoApp importers"; }
log messages

        /// <summary>
   }

     /// The name publicof Bitmapthe Imageimporter
        {/// </summary>
        /// <remarks>Used in importer get { return new Bitmap(16, 16);}
        }
selection dialogs</remarks>
        public IEnumerable<Type>string SupportedItemTypesName
        {
            get { yieldreturn return typeof(TimeSeries)"WaterML2 time series importer"; }
        }

        /// <summary>
 public bool CanImportOnRootLevel
     /// The category {
of the importer
        /// </summary>
 get { return true; }
   /// <remarks>Used in importer selection }dialogs</remarks>

        public string FileFilterCategory
        {
            get { return "WaterML2 files|*.XMLVolume model importers"; }
        }

        public string TargetDataDirectory { get; set; }

/// <summary>
        /// The image of the publicimporter
 bool ShouldCancel { get; set; }

  /// </summary>
     public ImportProgressChangedDelegate ProgressChanged { get; set; }

  /// <remarks>Used in importer selection dialogs</remarks>
        public object ImportItem(string path, object target = null)Bitmap Image
        {
            //get Check{ thereturn file path
  new Bitmap(16, 16); }
        }

  if (!File.Exists(path))
     /// <summary>
      {
  /// The data types supported by the importer
       log.Error("File does not exist");

 /// </summary>
        public IEnumerable<Type> SupportedItemTypes
       return null;{
            }

get { yield return typeof(TimeSeries); }
       // Obtain}

 a new time series or check the provided target for being a time series
/// <summary>
        /// Indicates that the importer can import at root var timeSeries = target == null
level (folder/project). In other
        /// words, indicates that the <see cref="ImportItem"/> method can be ?called newwithout
 TimeSeries { Name = Path.GetFileNameWithoutExtension(path), Components = { new Variable<double>() } } /// specifying a time series target...
        /// </summary>
       : targetpublic asbool TimeSeries;
CanImportOnRootLevel
        {
    if (timeSeries == null)
        get { return true; {}
        }

        log.Error("Target is of the wrong type (should be time series)");

      /// <summary>
        /// The file filter of the importer
          return null;/// </summary>
        /// <remarks>Used in  }

file selection dialogs</remarks>
        public string FileFilter
    // Load the XML document{
            get var{ docreturn = XDocument.Load(path);

"WaterML2 files|*.XML"; }
        }

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

          /// Path where external data files can be copied into
        /// </summary>
        /// Obtain<remarks>Not therelevant measurementin TVPthis tagstutorial</remarks>
        public string TargetDataDirectory { varget; measurements = xElements.Where(element => element.Name.LocalName == "MeasurementTVP");

    set; }

        /// <summary>
        /// GetWhether theor correspondingnot timean andimport valuetask forshould eachbe measurement tagcancelled
        /// </summary>
        /// foreach<remarks>Not (varpart measurementof in measurements)
this tutorial</remarks>
        public bool ShouldCancel { get; set; {}

        /// <summary>
       var time/// = DateTime.Parse(measurement.Elements().First(e => e.Name.LocalName == "time").Value);
Fired when progress has been changed
        /// </summary>
        /// var<remarks>Not valuepart = double.Parse(measurement.Elements().First(e => e.Name.LocalName == "value").Value);

in this tutorial</remarks>
        public ImportProgressChangedDelegate ProgressChanged { get; set; }

     timeSeries[time] = value;
 /// <summary>
        /// Imports }

WaterML2 data from the file with path      // Return the time series<paramref name="path"/> to the
        /// time series  return timeSeries;<paramref name="target"/>
        }
    }

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;

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