Class HeidenhainTcpmSyntax
- Namespace
- Hi.NcParsers.ParsingSyntaxs.Heidenhain
- Assembly
- HiMech.dll
Captures the modern-TNC RTCP statement pair into Parsing.TCPM:
FUNCTION TCPM [args] (RTCP on — the M128 successor) and
FUNCTION RESET TCPM (RTCP off). The behavior-tuning argument
words (F TCP / F CONT / AXIS POS / AXIS SPAT / PATHCTRL AXIS /
PATHCTRL VECTOR) are corpus-zero and swept verbatim into the
record's Args — recognized-but-not-simulated (the Logic RTCP
consumer warns); activation/deactivation itself is simulated. Must
run before the shared F tag-value syntax so an argument like
F TCP can never be misread as a feed word.
public class HeidenhainTcpmSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource
- Inheritance
-
HeidenhainTcpmSyntax
- Implements
- Inherited Members
- Extension Methods
Examples
Bare activation:
#BeforeBuild.UnparsedText: FUNCTION TCPM
#AfterBuild:
{ "Parsing": { "TCPM": { "Bare": true } } }
Activation with behavior arguments (recorded, not simulated):
#BeforeBuild.UnparsedText: FUNCTION TCPM F TCP AXIS POS PATHCTRL AXIS
#AfterBuild:
{ "Parsing": { "TCPM": { "Args": "F TCP AXIS POS PATHCTRL AXIS" } } }
Deactivation:
#BeforeBuild.UnparsedText: FUNCTION RESET TCPM
#AfterBuild:
{ "Parsing": { "TCPM": { "Reset": true } } }
Constructors
HeidenhainTcpmSyntax()
Initializes a new instance with default settings.
public HeidenhainTcpmSyntax()
HeidenhainTcpmSyntax(XElement)
Initializes a new instance by deserializing from the given XML element.
public HeidenhainTcpmSyntax(XElement src)
Parameters
srcXElementSource XML element.
Fields
ArgsKey
Record key holding the swept behavior-argument text.
public const string ArgsKey = "Args"
Field Value
KeyConst
Key of the record written to Parsing.
public const string KeyConst = "TCPM"
Field Value
ResetKey
Record key marking the FUNCTION RESET TCPM (off) form.
public const string ResetKey = "Reset"
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