685 lines
22 KiB
HTML
685 lines
22 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class SessionMessage | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class SessionMessage | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="Represents a message in the machining process that can contain various types of data such as source commands, machining steps, exceptions, and tagged messages.">
|
|
<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 "{query}"">
|
|
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
|
<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="Hi.MachiningProcs.SessionMessage">
|
|
|
|
|
|
|
|
<h1 id="Hi_MachiningProcs_SessionMessage" data-uid="Hi.MachiningProcs.SessionMessage" class="text-break">
|
|
Class SessionMessage
|
|
</h1>
|
|
|
|
<div class="facts text-secondary">
|
|
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.MachiningProcs.html">MachiningProcs</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>Represents a message in the machining process that can contain various types of data
|
|
such as source commands, machining steps, exceptions, and tagged messages.</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class SessionMessage</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">SessionMessage</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>
|
|
</dd></dl>
|
|
|
|
<dl class="typelist extensionMethods">
|
|
<dt>Extension Methods</dt>
|
|
<dd>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="constructors">Constructors
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage__ctor_" data-uid="Hi.MachiningProcs.SessionMessage.#ctor*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage__ctor_System_Int32_System_Object_" data-uid="Hi.MachiningProcs.SessionMessage.#ctor(System.Int32,System.Object)">
|
|
SessionMessage(int, object)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.MachiningProcs.SessionMessage.html">SessionMessage</a> class.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public SessionMessage(int index, object src)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>index</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
|
<dd><p>The index of the message.</p>
|
|
</dd>
|
|
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
|
<dd><p>The source data.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="properties">Properties
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage_ClStripPos_" data-uid="Hi.MachiningProcs.SessionMessage.ClStripPos*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage_ClStripPos" data-uid="Hi.MachiningProcs.SessionMessage.ClStripPos">
|
|
ClStripPos
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the cutter location strip position.
|
|
gets null if the <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_Data">Data</a> is not <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_ClStripPos">ClStripPos</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ClStripPos ClStripPos { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.CutterLocations.ClStrips.ClStripPos.html">ClStripPos</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage_Data_" data-uid="Hi.MachiningProcs.SessionMessage.Data*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage_Data" data-uid="Hi.MachiningProcs.SessionMessage.Data">
|
|
Data
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the data contained in the message.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public object Data { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage_DirectInstantSourceCommand_" data-uid="Hi.MachiningProcs.SessionMessage.DirectInstantSourceCommand*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage_DirectInstantSourceCommand" data-uid="Hi.MachiningProcs.SessionMessage.DirectInstantSourceCommand">
|
|
DirectInstantSourceCommand
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the direct source command from the data.
|
|
gets null if the <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_Data">Data</a> is not <a class="xref" href="Hi.MachiningSteps.ISourceCommand.html">ISourceCommand</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ISourceCommand DirectInstantSourceCommand { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.MachiningSteps.ISourceCommand.html">ISourceCommand</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage_Exception_" data-uid="Hi.MachiningProcs.SessionMessage.Exception*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage_Exception" data-uid="Hi.MachiningProcs.SessionMessage.Exception">
|
|
Exception
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the exception.
|
|
gets null if the <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_Data">Data</a> is not <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_Exception">Exception</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Exception Exception { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage_Index_" data-uid="Hi.MachiningProcs.SessionMessage.Index*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage_Index" data-uid="Hi.MachiningProcs.SessionMessage.Index">
|
|
Index
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the index of the message.
|
|
The UI name is 'Serial.'.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Present("Message Index", "M.I.", PhysicsUnit.None, "G")]
|
|
public int Index { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage_InstantSourceCommand_" data-uid="Hi.MachiningProcs.SessionMessage.InstantSourceCommand*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage_InstantSourceCommand" data-uid="Hi.MachiningProcs.SessionMessage.InstantSourceCommand">
|
|
InstantSourceCommand
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the source command, either directly or from the associated milling step.
|
|
gets null if both <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_DirectInstantSourceCommand">DirectInstantSourceCommand</a> and the SourceCommand
|
|
from <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_ClStripPos">ClStripPos</a>'s State are null.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ISourceCommand InstantSourceCommand { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.MachiningSteps.ISourceCommand.html">ISourceCommand</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage_MachiningStep_" data-uid="Hi.MachiningProcs.SessionMessage.MachiningStep*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage_MachiningStep" data-uid="Hi.MachiningProcs.SessionMessage.MachiningStep">
|
|
MachiningStep
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the milling step from the cutter location strip position.
|
|
gets null if <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_ClStripPos">ClStripPos</a> is null or its State is not a <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_MachiningStep">MachiningStep</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public MachiningStep MachiningStep { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage_Message_" data-uid="Hi.MachiningProcs.SessionMessage.Message*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage_Message" data-uid="Hi.MachiningProcs.SessionMessage.Message">
|
|
Message
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the message text from either the multi-tag message or exception.
|
|
gets null if both <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_MultiTagMessage">MultiTagMessage</a> and <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_Exception">Exception</a> are null,
|
|
or if <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_MultiTagMessage">MultiTagMessage</a>.Message is null.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Present("Message", "Msg", PhysicsUnit.None, "G")]
|
|
public string Message { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage_MessageOrNcText_" data-uid="Hi.MachiningProcs.SessionMessage.MessageOrNcText*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage_MessageOrNcText" data-uid="Hi.MachiningProcs.SessionMessage.MessageOrNcText">
|
|
MessageOrNcText
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the message text or NC code text.
|
|
gets null if all sources (<a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_InstantSourceCommand">InstantSourceCommand</a>, <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_MultiTagMessage">MultiTagMessage</a>,
|
|
<a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_Exception">Exception</a>, and <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_Data">Data</a>) are null or cannot provide text.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Present("Message/NC", "Msg/NC", PhysicsUnit.None, "G")]
|
|
public string MessageOrNcText { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage_MessageRoleText_" data-uid="Hi.MachiningProcs.SessionMessage.MessageRoleText*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage_MessageRoleText" data-uid="Hi.MachiningProcs.SessionMessage.MessageRoleText">
|
|
MessageRoleText
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the message type text for UI display.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Present("Role", "Role", PhysicsUnit.None, "G")]
|
|
public string MessageRoleText { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage_MultiTagMessage_" data-uid="Hi.MachiningProcs.SessionMessage.MultiTagMessage*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage_MultiTagMessage" data-uid="Hi.MachiningProcs.SessionMessage.MultiTagMessage">
|
|
MultiTagMessage
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the multi-tag message.
|
|
gets null if the <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_Data">Data</a> is not <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_MultiTagMessage">MultiTagMessage</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public MultiTagMessage MultiTagMessage { get; set; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Common.Messages.MultiTagMessage.html">MultiTagMessage</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage_Tags_" data-uid="Hi.MachiningProcs.SessionMessage.Tags*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage_Tags" data-uid="Hi.MachiningProcs.SessionMessage.Tags">
|
|
Tags
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the tags associated with the message.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public HashSet<string> Tags { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.hashset-1">HashSet</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_MachiningProcs_SessionMessage_Tags_remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>Different from <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_MultiTagMessage">MultiTagMessage</a>.<a class="xref" href="Hi.Common.Messages.MultiTagMessage.html#Hi_Common_Messages_MultiTagMessage_Tags">Tags</a>,
|
|
the Tags here includes the infomation of the <a class="xref" href="Hi.MachiningProcs.SessionMessage.html#Hi_MachiningProcs_SessionMessage_Data">Data</a>.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="methods">Methods
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_MachiningProcs_SessionMessage_ToString_" data-uid="Hi.MachiningProcs.SessionMessage.ToString*"></a>
|
|
|
|
<h3 id="Hi_MachiningProcs_SessionMessage_ToString" data-uid="Hi.MachiningProcs.SessionMessage.ToString">
|
|
ToString()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Returns a string representation of the message data.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
|
</div>
|
|
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>A string representation of the message data.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</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>
|