HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/sample/Sample.Common.DemoSessionMessage.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
      <title>Class DemoSessionMessage | HiAPI-C# 2025 </title>
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <meta name="title" content="Class DemoSessionMessage | HiAPI-C# 2025 ">
      
      
      <link rel="icon" href="../img/HiAPI.favicon.ico">
      <link rel="stylesheet" href="../public/docfx.min.css">
      <link rel="stylesheet" href="../public/main.css">
      <meta name="docfx:navrel" content="../toc.html">
      <meta name="docfx:tocrel" content="toc.html">
      
      <meta name="docfx:rel" content="../">
      
      
      
      <meta name="loc:inThisArticle" content="In this article">
      <meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
      <meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
      <meta name="loc:tocFilter" content="Filter by title">
      <meta name="loc:nextArticle" content="Next">
      <meta name="loc:prevArticle" content="Previous">
      <meta name="loc:themeLight" content="Light">
      <meta name="loc:themeDark" content="Dark">
      <meta name="loc:themeAuto" content="Auto">
      <meta name="loc:changeTheme" content="Change theme">
      <meta name="loc:copy" content="Copy">
      <meta name="loc:downloadPdf" content="Download PDF">

      <script type="module" src="./../public/docfx.min.js"></script>

      <script>
        const theme = localStorage.getItem('theme') || 'auto'
        document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
      </script>

  </head>

  <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
    <header class="bg-body border-bottom">
      <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
        <div class="container-xxl flex-nowrap">
          <a class="navbar-brand" href="../index.html">
            <img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
            
          </a>
          <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
            <i class="bi bi-three-dots"></i>
          </button>
          <div class="collapse navbar-collapse" id="navpanel">
            <div id="navbar">
              <form class="search" role="search" id="search">
                <i class="bi bi-search"></i>
                <input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
              </form>
            </div>
          </div>
        </div>
      </nav>
    </header>

    <main class="container-xxl">
      <div class="toc-offcanvas">
        <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
          <div class="offcanvas-header">
            <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
            <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
          </div>
          <div class="offcanvas-body">
            <nav class="toc" id="toc"></nav>
          </div>
        </div>
      </div>

      <div class="content">
        <div class="actionbar">
          <button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
            <i class="bi bi-list"></i>
          </button>

          <nav id="breadcrumb"></nav>
        </div>

        <article data-uid="Sample.Common.DemoSessionMessage">



  <h1 id="Sample_Common_DemoSessionMessage" data-uid="Sample.Common.DemoSessionMessage" class="text-break">
Class DemoSessionMessage  
  </h1>

  <div class="facts text-secondary">
    <dl><dt>Namespace</dt><dd><a class="xref" href="Sample.html">Sample</a>.<a class="xref" href="Sample.Common.html">Common</a></dd></dl>
  <dl><dt>Assembly</dt><dd>Hi.Sample.dll</dd></dl>
  </div>

  <div class="markdown summary"></div>
  <div class="markdown conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static class DemoSessionMessage</code></pre>
  </div>




  <dl class="typelist inheritance">
    <dt>Inheritance</dt>
    <dd>
      <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
      <div><span class="xref">DemoSessionMessage</span></div>
    </dd>
  </dl>



  <dl class="typelist inheritedMembers">
    <dt>Inherited Members</dt>
    <dd>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
    </div>
  </dd></dl>




  <h2 id="Sample_Common_DemoSessionMessage_remarks">Remarks</h2>
  <div class="markdown level0 remarks"><h3 id="source-code">Source Code</h3>
<pre><code class="lang-csharp" name="SampleCode">using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Hi.Common.FileLines;
using Hi.Common.Messages;
using Hi.HiNcKits;
using Hi.MachiningProcs;
using Hi.MachiningSteps;
using Hi.NcParsers;

namespace Sample.Common;

/// &lt;remarks&gt;
/// ### Source Code
/// [!code-csharp[SampleCode](~/../Hi.Sample/Common/DemoSessionMessage.cs)]
/// &lt;/remarks&gt;
public static class DemoSessionMessage
{
    #region Demo_UseSessionMessageHost
    internal static void DemoUseSessionMessageHost(LocalProjectService localProjectService)
    {
        // Session messages are partitioned by kind into three sinks on LocalProjectService:
        // - ShellProgress: session-level routine / lifecycle messages
        //   (session-scoped: null outside BeginSession/EndSession).
        // - NcDiagnosticProgress: NC-pipeline diagnostics, anchored to the NC source sentence.
        // - StepDiagnosticProgress: diagnostics anchored to a motion step.

        ShellProgress shellProgress = localProjectService.ShellProgress;
        List&lt;IMessage&gt; shellMessages = shellProgress == null
            ? new List&lt;IMessage&gt;() : shellProgress.Messages.ToList();
        foreach (IMessage message in shellMessages)
            Console.WriteLine(
                $&quot;Shell [{message.GetSeverity()}] {message.GetId()}: {message.GetNotification()}&quot;);

        foreach (NcDiagnostic diagnostic in
            localProjectService.NcDiagnosticProgress.Diagnostics.ToList())
        {
            var ncLine = diagnostic.SentenceCarrier?.GetSentence()?.FirstIndexedFileLine;
            Console.WriteLine(
                $&quot;NC [{diagnostic.GetSeverity()}] {diagnostic.GetId()}: {diagnostic.GetNotification()}; &quot; +
                $&quot;File: {ncLine?.FilePath}; LineNo: {ncLine?.GetLineNo()}; NC: {ncLine?.Line}&quot;);
        }

        foreach (StepDiagnostic diagnostic in
            localProjectService.StepDiagnosticProgress.Messages.ToList())
            Console.WriteLine(
                $&quot;Step {diagnostic.StepIndex} [{diagnostic.GetSeverity()}] &quot; +
                $&quot;{diagnostic.GetId()}: {diagnostic.GetNotification()}&quot;);

        File.WriteAllLines(&quot;output-session-messages.txt&quot;,
            shellMessages.Select(m =&gt;
            $&quot;[{m.GetSeverity()}] {m.GetId()}: {m.GetNotification()}&quot;));
    }
    #endregion

    #region ShowStepPresent
    internal static void ShowStepPresent(
        UserService userEnv, MachiningStep machiningStep)
    {
        foreach (var entry in userEnv.DisplayedStepPresentAccessList)
        {
            var present = entry.Value.Present;
            var valueText = string.Format(&quot;{0:&quot; + present.DataFormatString + &quot;}&quot;, entry.Value.GetValueFunc.Invoke(machiningStep));
            Console.WriteLine($&quot;{present.ShortName}: {valueText} {present.TailUnitString} ({present.Name} [{entry.Key}])&quot;);
        }
    }
    #endregion
}
</code></pre></div>



</article>

        <div class="contribution d-print-none">
        </div>


      </div>

      <div class="affix">
        <nav id="affix"></nav>
      </div>
    </main>

    <div class="container-xxl search-results" id="search-results"></div>

    <footer class="border-top text-secondary">
      <div class="container-xxl">
        <div class="flex-fill">
          <span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
        </div>
      </div>
    </footer>
  </body>
</html>