Class TapeBoundarySyntax
- Namespace
- Hi.NcParsers.ParsingSyntaxs
- Assembly
- HiMech.dll
Detects the % tape leader / trailer at the start of a block
and records it under TapeBoundary on the block JSON.
Universal across ISO controllers (Fanuc, Mazak, Syntec, Siemens) —
a brand's program-identifier header (e.g. Fanuc O1234) is a
separate concern handled by its own brand-specific syntax.
public class TapeBoundarySyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource
- Inheritance
-
TapeBoundarySyntax
- Implements
- Inherited Members
- Extension Methods
Examples
#BeforeBuild.UnparsedText: %
#AfterBuild:
{
"TapeBoundary": { "Text": "" }
}
#BeforeBuild.UnparsedText: %foo
#AfterBuild:
{
"TapeBoundary": { "Text": "foo" }
}
#BeforeBuild.UnparsedText: % header text
#AfterBuild:
{
"TapeBoundary": { "Text": "header text" }
}
Constructors
TapeBoundarySyntax()
Parameterless instance for bundle composition (no XML state).
public TapeBoundarySyntax()
TapeBoundarySyntax(XElement)
XML ctor (no child elements; reserved for forward compatibility).
public TapeBoundarySyntax(XElement src)
Parameters
Properties
Name
Syntax kind name (typically the concrete type name).
public string Name { get; }
Property Value
XName
XML element name for Generators registration.
public static string XName { get; }
Property Value
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
syntaxPieceNodeLazyLinkedListNode<SyntaxPiece>ncDependencyListList<INcDependency>ncDiagnosticProgressNcDiagnosticProgress
IsPreviousNodeTapeBoundary(LazyLinkedListNode<SyntaxPiece>)
Returns true if the previous block carries a TapeBoundary section, or if there is no previous block at all (start-of-stream is itself a tape boundary). Brand-specific program-identifier syntaxes use this to decide whether the current block can host a program-number header.
public static bool IsPreviousNodeTapeBoundary(LazyLinkedListNode<SyntaxPiece> node)
Parameters
Returns
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
baseDirectorystringThe base directory for resolving relative paths
relFilestringThe relative file path for the XML source
exhibitionOnlyboolif 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
factoryXFactory