Table of Contents

Class TagValueSyntax

Namespace
Hi.NcParsers.ParsingSyntaxs
Assembly
HiMech.dll

Concatenated tag-value syntax (no = sign). ex. Heidenhain: L X Q2 Y33.4 FQ1 ISO: X100.3Y3.3

public class TagValueSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource
Inheritance
TagValueSyntax
Implements
Derived
Inherited Members
Extension Methods

Constructors

TagValueSyntax(IEnumerable<string>, IEnumerable<string>, string)

Initializes a new instance with the given category path, tag list, and variable-tag pattern.

public TagValueSyntax(IEnumerable<string> categoryPath, IEnumerable<string> tags, string variableTag)

Parameters

categoryPath IEnumerable<string>

JSON path under Parsing where matches are written.

tags IEnumerable<string>

Single-letter tag names whose values are grabbed.

variableTag string

Regex/literal recognizing a variable reference as a value.

TagValueSyntax(XElement)

Initializes a new instance by deserializing from the given XML element.

public TagValueSyntax(XElement src)

Parameters

src XElement

Source XML element.

Properties

CategoryPath

JSON path under Parsing where matched tag-values are written.

public List<string> CategoryPath { get; set; }

Property Value

List<string>

Name

Syntax kind name (typically the concrete type name).

public string Name { get; }

Property Value

string

TagList

Single-letter tag names whose values are grabbed (e.g. X, Y, Z, F).

public List<string> TagList { get; set; }

Property Value

List<string>

VariableTag

Regex (or literal) that recognizes a variable reference token (e.g. Q2, #1, [#1+#2]) as the value of a tag.

public string VariableTag { get; set; }

Property Value

string

XName

XML element name used to register this syntax with XFactory.

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 virtual 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

ToValueJsonNode(string)

Converts a tag setup string value to a JsonNode. Override in derived classes for typed parsing (int, double). Variable text (e.g. Q2, #1, [#1+#2]) is kept as string.

protected virtual JsonNode ToValueJsonNode(string setup)

Parameters

setup string

Returns

JsonNode