-Add 'ResetOrigin' property to 'AutoResetStream'

-Update documentation
-update unit test

Author: BionicCode

BionicCode.Net/BionicCode.Utilities.Net.Core.Wpf/BionicCode.Utilities.Net.Core.Wpf.csproj

@@ -9,7 +9,7 @@
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/BionicCode/BionicCode.Net</PackageProjectUrl>
     <PackageIcon>BionicCode_Logo.png</PackageIcon>
-    <PackageTags>Base View Model ViewModel BaseViewModel AsyncRelayCommand Async RelayCommand WPF VisualTreeHelper Profiler Profiling Measure Measuring View Model ViewModel ExtensionMethods ObservablePropertyChangedCollection Collection ApplicationSettings Settings AppSettings MRU MostRecentlyUsedFile LastUsedFile RecentlyUsedFile EventAggregator Aggregator Event MVVMDialog MVVM Dialog DialogService ExtensioMethod EnumExtension InvertExtension MarkupExtension EventAggregator Aggregator Event MVVM NullObject NullObjectFactory Factory IFatory ValueChangedEventArgs AutoResetStream Stream PropertyValueChangedArgs FileExtension FileExtensions PropertyValueChanged RichTextBox AttachedBehavior Attached Behavior</PackageTags>
+    <PackageTags>Base View Model ViewModel BaseViewModel AsyncRelayCommand Async RelayCommand WPF VisualTreeHelper Profiler Profiling Measure Measuring View Model ViewModel ExtensionMethods ObservablePropertyChangedCollection Collection ApplicationSettings Settings AppSettings MRU MostRecentlyUsedFile LastUsedFile RecentlyUsedFile EventAggregator Aggregator Event MVVMDialog MVVM Dialog DialogService ExtensioMethod EnumExtension Enum Extension InvertExtension MarkupExtension EventAggregator Aggregator Event MVVM NullObject NullObjectFactory Factory IFatory ValueChangedEventArgs AutoResetStream Stream PropertyValueChangedArgs FileExtension FileExtensions PropertyValueChanged RichTextBox AttachedBehavior Attached Behavior</PackageTags>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
     <Company>BionicCode</Company>
     <Copyright>2020</Copyright>

BionicCode.Net/BionicCode.Utilities.Net.Core.Wpf/Extensions/HelperExtensions.cs

@@ -44,19 +44,19 @@ public static bool TryFindVisualParentElement<TParent>(this DependencyObject chi
     /// <param name="elementName">The element name the visual parent must match.</param>
     /// <param name="resultElement"></param>
     /// <returns></returns>
-    public static bool TryFindVisualParentElementByName(
+    public static bool TryFindVisualParentElementByName<TChild>(
       this DependencyObject child,
       string elementName,
-      out FrameworkElement resultElement)
+      out TChild resultElement) where TChild : FrameworkElement
     {
       resultElement = null;
 
-      var parentElement = VisualTreeHelper.GetParent(child);
+      DependencyObject parentElement = VisualTreeHelper.GetParent(child);
 
       if (parentElement is FrameworkElement frameworkElement &&
           frameworkElement.Name.Equals(elementName, StringComparison.OrdinalIgnoreCase))
       {
-        resultElement = frameworkElement;
+        resultElement = frameworkElement as TChild;
         return true;
       }
 
@@ -110,14 +110,13 @@ public static bool TryFindVisualChildElement<TChild>(this DependencyObject paren
     /// <param name="childElementName">The name the visual child's name must match.</param>
     /// <param name="resultElement">The found element or <c>null</c> if no matching element was found.</param>
     /// <returns><c>true</c> when an element with the specified <paramref name="childElementName"/> was found, otherwise <c>false</c>.</returns>
-    public static bool TryFindVisualChildElementByName(
+    public static bool TryFindVisualChildElementByName<TChild>(
       this DependencyObject parent,
       string childElementName,
-      out FrameworkElement resultElement)
+      out TChild resultElement) where TChild : FrameworkElement
     {
       resultElement = null;
-
-
+      
       if (parent is Popup popup)
       {
         parent = popup.Child;
@@ -132,10 +131,10 @@ public static bool TryFindVisualChildElementByName(
         DependencyObject childElement = VisualTreeHelper.GetChild(parent, childIndex);
 
         if (childElement is FrameworkElement uiElement && uiElement.Name.Equals(
-              childElementName,
-              StringComparison.OrdinalIgnoreCase))
+          childElementName,
+          StringComparison.OrdinalIgnoreCase))
         {
-          resultElement = uiElement;
+          resultElement = uiElement as TChild;
           return true;
         }
 

BionicCode.Net/BionicCode.Utilities.Net.Framework.Wpf/Extensions/HelperExtensions.cs

@@ -44,19 +44,19 @@ public static bool TryFindVisualParentElement<TParent>(this DependencyObject chi
     /// <param name="elementName">The element name the visual parent must match.</param>
     /// <param name="resultElement"></param>
     /// <returns></returns>
-    public static bool TryFindVisualParentElementByName(
+    public static bool TryFindVisualParentElementByName<TChild>(
       this DependencyObject child,
       string elementName,
-      out FrameworkElement resultElement)
+      out TChild resultElement) where TChild : FrameworkElement
     {
       resultElement = null;
 
-      var parentElement = VisualTreeHelper.GetParent(child);
+      DependencyObject parentElement = VisualTreeHelper.GetParent(child);
 
       if (parentElement is FrameworkElement frameworkElement &&
           frameworkElement.Name.Equals(elementName, StringComparison.OrdinalIgnoreCase))
       {
-        resultElement = frameworkElement;
+        resultElement = frameworkElement as TChild;
         return true;
       }
 
@@ -110,14 +110,13 @@ public static bool TryFindVisualChildElement<TChild>(this DependencyObject paren
     /// <param name="childElementName">The name the visual child's name must match.</param>
     /// <param name="resultElement">The found element or <c>null</c> if no matching element was found.</param>
     /// <returns><c>true</c> when an element with the specified <paramref name="childElementName"/> was found, otherwise <c>false</c>.</returns>
-    public static bool TryFindVisualChildElementByName(
+    public static bool TryFindVisualChildElementByName<TChild>(
       this DependencyObject parent,
       string childElementName,
-      out FrameworkElement resultElement)
+      out TChild resultElement) where TChild : FrameworkElement
     {
       resultElement = null;
-
-
+      
       if (parent is Popup popup)
       {
         parent = popup.Child;
@@ -135,7 +134,7 @@ public static bool TryFindVisualChildElementByName(
               childElementName,
               StringComparison.OrdinalIgnoreCase))
         {
-          resultElement = uiElement;
+          resultElement = uiElement as TChild;
           return true;
         }
 

BionicCode.Net/BionicCode.Utilities.Net.Standard/BionicCode.Utilities.Net.Standard.xml

@@ -25,6 +25,12 @@ public Stream BaseStream
       }
     }
 
+    /// <summary>
+    /// Defines the position to which the stream should reset to.
+    /// </summary>
+    /// <value>A <see cref="SeekOrigin"/> value.</value>
+    public SeekOrigin ResetOrigin { get; set; }
+
     /// <summary>
     /// Gets whether the decorated underlying <see cref="Stream"/> will be closed or disposed when the <see cref="AutoResetStream"/> instance is closed or disposed. Use constructor to set the value in order to configure the behavior.
     /// </summary>
@@ -42,26 +48,39 @@ public AutoResetStream()
     /// Constructor which accepts the <see cref="Stream"/> instance to decorate in order to extend its behavior.
     /// </summary>
     /// <param name="baseStream">The <see cref="Stream"/> instance to decorate in order to extend its behavior.</param>
-    public AutoResetStream(Stream baseStream) : this(baseStream, true)
+    public AutoResetStream(Stream baseStream) : this(baseStream, SeekOrigin.Begin, true)
     {
     }
 
     /// <summary>
     /// Constructor which accepts the <see cref="Stream"/> instance to decorate in order to extend its behavior.
     /// </summary>
     /// <param name="baseStream">The <see cref="Stream"/> instance to decorate in order to extend its behavior.</param>
-    /// <param name="isDisposingDecoratedStream">When set to <c>true</c> the decorated underlying <see cref="Stream"/> will be disposed or closed too, if the <see cref="AutoResetStream"/> is disposed or closed.</param>
-    public AutoResetStream(Stream baseStream, bool isDisposingDecoratedStream)
+    /// <param name="leaveDecoratedStreamOpen">When set to <c>true</c> the decorated underlying <see cref="Stream"/> will be disposed or closed too, if the <see cref="AutoResetStream"/> is disposed or closed.</param>
+    public AutoResetStream(Stream baseStream, bool leaveDecoratedStreamOpen) : this(baseStream, SeekOrigin.Begin, leaveDecoratedStreamOpen)
+    {
+      this.BaseStream = baseStream;
+      this.IsDisposingDecoratedStream = leaveDecoratedStreamOpen;
+    }
+
+    /// <summary>
+    /// Constructor which accepts the <see cref="Stream"/> instance to decorate in order to extend its behavior.
+    /// </summary>
+    /// <param name="baseStream">The <see cref="Stream"/> instance to decorate in order to extend its behavior.</param>
+    /// <param name="resetOrigin">The origin to which the stream should be reset to.</param>
+    /// <param name="leaveDecoratedStreamOpen">When set to <c>true</c> the decorated underlying <see cref="Stream"/> will be disposed or closed too, if the <see cref="AutoResetStream"/> is disposed or closed.</param>
+    public AutoResetStream(Stream baseStream, SeekOrigin resetOrigin, bool leaveDecoratedStreamOpen)
     {
       this.BaseStream = baseStream;
-      this.IsDisposingDecoratedStream = isDisposingDecoratedStream;
+      this.IsDisposingDecoratedStream = leaveDecoratedStreamOpen;
+      this.ResetOrigin = resetOrigin;
     }
 
     /// <summary>
     /// Resets the <see cref="Stream.Position"/> to an offset of '0' relative to the provided <paramref name="seekOrigin"/>.
     /// </summary>
     /// <param name="seekOrigin">The optional relative position of the <see cref="Stream"/> to apply the zero offset to. The default is <see cref="SeekOrigin.Begin"/>.</param>
-    public void Reset(SeekOrigin seekOrigin = SeekOrigin.Begin) => this.BaseStream.Seek(0, seekOrigin);
+    public void Reset(SeekOrigin seekOrigin = SeekOrigin.Current) => this.BaseStream.Seek(0, seekOrigin == SeekOrigin.Current ? this.ResetOrigin : seekOrigin);
 
     #region Overrides of Stream
 

BionicCode.Net/BionicCode.Utilities.Net.Standard/IO/AutoResetStream.cs

@@ -0,0 +1,104 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Linq;
+
+namespace BionicCode.Utilities.Net.Standard.Profiling
+{
+  /// <summary>
+  /// Helper methods to measure code execution time.
+  /// </summary>
+  public static class Profiler
+  {
+    /// <summary>
+    /// A <see cref="Action{T}"/> delegate that can be used to redirect the log output. By default the log output will be send to the output window.
+    /// </summary>
+    /// <value>A <see cref="Action{T}"/> delegate which will be invoked to output the elapsed <see cref="TimeSpan"/>. The default delegate will print the output to the output window.</value>
+    public static Action<TimeSpan> LogPrinter { get; set; }
+
+    /// <summary>
+    /// Measures the execution time of a method.
+    /// </summary>
+    /// <param name="action">The code to measure execution time.</param>
+    /// <returns>The execution time as a <see cref="TimeSpan"/>.</returns>
+    /// <remarks>Specify a <see cref="LogPrinter"/> <see cref="Action"/> to customize the output target and formatting.</remarks>
+    public static TimeSpan LogTime(Action action)
+    {
+      var stopwatch = new Stopwatch();
+      stopwatch.Start();
+      action.Invoke();
+      stopwatch.Stop();
+      TimeSpan stopwatchElapsed = stopwatch.Elapsed;
+      if (Profiler.LogPrinter == null)
+      {
+        Profiler.LogPrinter = (elapsedTime) =>
+          Console.WriteLine($"Elapsed time: {elapsedTime.TotalMilliseconds} [ms]");
+      }
+      Profiler.LogPrinter?.Invoke(stopwatchElapsed);
+
+      return stopwatchElapsed;
+    }
+
+
+    /// <summary>
+    /// Measures the execution time of a method.
+    /// </summary>
+    /// <param name="action">The code to measure execution time.</param>
+    /// <param name="runCount">Number of iterations the <paramref name="action"/> should be executed.</param>
+    /// <returns>A list of execution times for all <paramref name="runCount"/> number of iterations <see cref="TimeSpan"/>.</returns>
+    /// <remarks>Specify a <see cref="LogPrinter"/> <see cref="Action"/> to customize the output target and formatting.</remarks>
+    public static List<TimeSpan> LogTimes(Action action, int runCount)
+    {
+      if (Profiler.LogPrinter == null)
+      {
+        Profiler.LogPrinter = (elapsedTime) =>
+          Console.WriteLine($"Iteration #{runCount}: Elapsed time: {elapsedTime.TotalMilliseconds} [ms]");
+      }
+      var stopwatch = new Stopwatch();
+      var measuredTimes = new List<TimeSpan>();
+
+      for (; runCount > 0; runCount--)
+      {
+        stopwatch.Start();
+        action.Invoke();
+        stopwatch.Stop();
+        TimeSpan stopwatchElapsed = stopwatch.Elapsed;
+        measuredTimes.Add(stopwatchElapsed);
+        Profiler.LogPrinter.Invoke(stopwatchElapsed);
+      }
+
+      return measuredTimes;
+    }
+
+    /// <summary>
+    /// Measures the execution time of a method.
+    /// </summary>
+    /// <param name="action">The code to measure execution time.</param>
+    /// <param name="runCount">Number of iterations the <paramref name="action"/> should be executed.</param>
+    /// <returns>The average execution time of all <paramref name="runCount"/> number of iterations as <see cref="TimeSpan"/>.</returns>
+    /// <remarks>Specify a <see cref="LogPrinter"/> <see cref="Action"/> to customize the output target and formatting.</remarks>
+    public static TimeSpan LogAverageTime(Action action, int runCount)
+    {
+      var stopwatch = new Stopwatch();
+      var measuredTimes = new List<TimeSpan>();
+
+      for (; runCount > 0; runCount--)
+      {
+        stopwatch.Start();
+        action.Invoke();
+        stopwatch.Stop();
+        TimeSpan stopwatchElapsed = stopwatch.Elapsed;
+        measuredTimes.Add(stopwatchElapsed);
+      }
+
+      var logAverageTime = new TimeSpan((long) measuredTimes.Average((time) => time.Ticks));
+      if (Profiler.LogPrinter == null)
+      {
+        Profiler.LogPrinter = (elapsedTime) =>
+          Console.WriteLine($"Iterations={runCount}; Average elapsed time: {elapsedTime.TotalMilliseconds} [ms]");
+      }
+      Profiler.LogPrinter.Invoke(logAverageTime);
+      return logAverageTime;
+    }
+  }
+}

BionicCode.Net/BionicCode.Utilities.Net.Standard/Profiling/Profiler.cs

@@ -26,6 +26,7 @@ public void Initialize()
 
     private void FillStream()
     {
+      var f = new FileStream("C:/Temp", FileMode.CreateNew);
       var memStream = new MemoryStream();
       using (var streamWriter = new StreamWriter(memStream, Encoding.Default, 1024, true))
       {