Class TailCommentSyntax

Namespace

Hi.NcParsers.ParsingSyntaxs.CommentSyntaxs

Assembly

HiMech.dll

In-situ syntax that strips a trailing comment from the NC line: text from a configured TailSymbol to end-of-line is moved into Comment on the block JSON.

public class TailCommentSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource

Inheritance

object

TailCommentSyntax

Implements

ISituNcSyntax

INcSyntax

IMakeXmlSource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Examples

#BeforeBuild.UnparsedText: ;header comment (with TailSymbol=";") #AfterBuild:

{
  "Comment": { "Symbol": ";", "Text": "header comment" }
}

#BeforeBuild.UnparsedText: G01 X100 ;mid comment (with TailSymbol=";") #AfterBuild:

{
  "UnparsedText": "G01 X100",
  "Comment": { "Symbol": ";", "Text": "mid comment" }
}

Constructors

TailCommentSyntax(string)

Creates syntax with the given tail marker; used from code or tests without XML.

public TailCommentSyntax(string tailSymbol)

Parameters

tailSymbol string

Marker that starts the tail comment segment.

TailCommentSyntax(XElement)

Loads TailSymbol from persisted XML.

public TailCommentSyntax(XElement src)

Parameters

src XElement

Serialized syntax element.

Properties

Name

Syntax kind name (typically the concrete type name).

public string Name { get; }

Property Value

string

TailSymbol

First character(s) of the tail comment marker (e.g. ; or //).

public string TailSymbol { get; set; }

Property Value

string

XName

XML element name for Generators registration.

public static string XName { get; }

Property Value

string

Methods

Build(LazyLinkedListNode<SyntaxPiece>, List<INcDependency>, NcDiagnosticProgress)

Build syntax arrangement into the syntaxPieceNode in-place.

public void Build(LazyLinkedListNode<SyntaxPiece> syntaxPieceNode, List<INcDependency> ncDependencyList, NcDiagnosticProgress ncDiagnosticProgress)

Parameters

syntaxPieceNode LazyLinkedListNode<SyntaxPiece>

ncDependencyList List<INcDependency>

ncDiagnosticProgress NcDiagnosticProgress

MakeXmlSource(string, string, bool)

Creates an XML representation of the object. This method may also generate additional resources such as related files.

public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

baseDirectory string

The base directory for resolving relative paths

relFile string

The relative file path for the XML source

exhibitionOnly bool

if true, the extended file creation is suppressed.

Returns

XElement

An XML element representing the object's state

Remarks

For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied. The baseDirectory is typically the folder at the nearest configuration file folder. Since the folder can be moving with the configuration file.

Reg(XFactory)

Registers this type's deserializer with the given XFactory (or Default when factory is null). Idempotent.

public static void Reg(XFactory factory = null)

Parameters

factory XFactory