Class HeidenhainToolDefSyntax
- Namespace
- Hi.NcParsers.ParsingSyntaxs.Heidenhain
- Assembly
- HiMech.dll
Syntax for the Heidenhain TOOL DEF block. With a tool table active
the block pre-selects a tool — TOOL DEF 5 readies tool 5 in the
magazine for the next TOOL CALL, no change happens — and the older
in-program definition adds the tool's length and radius
(TOOL DEF 5 L+10 R+5). A bare TOOL DEF — NX's klartext post
writes one after every TOOL CALL — names nothing and is consumed
with no record. Handles: TOOL DEF [ToolId|“ToolName”] [L…] [R…].
The record is consumed by
HeidenhainToolPreselectSyntax.
public class HeidenhainToolDefSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource
- Inheritance
-
HeidenhainToolDefSyntax
- Implements
- Inherited Members
- Extension Methods
Examples
#BeforeBuild.UnparsedText: TOOL DEF 5
#AfterBuild:
{
"Parsing": {
"TOOL DEF": { "T": "5" }
}
}
#BeforeBuild.UnparsedText: TOOL DEF 5 L+10 R+5
#AfterBuild:
{
"Parsing": {
"TOOL DEF": { "L": "+10", "R": "+5", "T": "5" }
}
}
#BeforeBuild.UnparsedText: TOOL DEF (bare: consumed, nothing recorded)
#AfterBuild:
{}
Constructors
HeidenhainToolDefSyntax()
Initializes a new instance with default settings.
public HeidenhainToolDefSyntax()
HeidenhainToolDefSyntax(XElement)
Initializes a new instance by deserializing from the given XML element.
public HeidenhainToolDefSyntax(XElement src)
Parameters
srcXElementSource XML element.
Fields
KeyConst
Key of the record written under Parsing.
public const string KeyConst = "TOOL DEF"
Field Value
Properties
Name
Syntax kind name (typically the concrete type name).
public string Name { get; }
Property Value
XName
XML element name used to register this syntax with XFactory.
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
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