Table of Contents

Class HeidenhainMFunctionSyntax

Namespace
Hi.NcParsers.LogicSyntaxs.Heidenhain
Assembly
HiMech.dll

Heidenhain-specific M-function semantics for the near-universal corpus family:

  • M126/M127 — shortest-path rotary traverse on/off. Writes the modal RotaryWrap { Shortest } section consumed by McAbcCyclicPathSyntax (absent = shortest, the shared default); the Heidenhain preset's Logic ModalCarry tracks the section.
  • M128/M129 — RTCP on/off. P1 consume-level: the captured Parsing.M128 record (with its feed-limit F) and the M129 flag are consumed into an Rtcp { IsActive, Term } record; activation warns Rtcp--NotSimulated until the P3 pivot transform lands. M129 (the off state — matching the simulation) is silent.
  • M140 MB — tool-axis retract. Executes a machine-coordinate move along +Z (the P1 tool axis; the P3 tilt work generalizes it): MB+n retracts by n mm, MB MAX retracts to the positive Z stroke limit (IStrokeLimitConfig; unresolvable limit warns M140--NoStrokeLimit and skips). The retract runs at the modal feed (the statement's F is recorded on the MotionEvent as RetractFeedrate, not folded into the modal feedrate).
Must run before McAbcCyclicPathSyntax (RotaryWrap) and before LinearMotionSyntax/McXyzSyntax (M140 occupies the block's MotionEvent). 
public class HeidenhainMFunctionSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource
Inheritance
HeidenhainMFunctionSyntax
Implements
Inherited Members
Extension Methods

Constructors

HeidenhainMFunctionSyntax()

Initializes a new instance with default settings.

public HeidenhainMFunctionSyntax()

HeidenhainMFunctionSyntax(XElement)

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

public HeidenhainMFunctionSyntax(XElement src)

Parameters

src XElement

Source XML element.

Fields

RotaryWrapSection

Modal section consumed by McAbcCyclicPathSyntax; absent = shortest (shared default).

public const string RotaryWrapSection = "RotaryWrap"

Field Value

string

RtcpSection

RTCP record section (P1 consume-level; P3 replaces with the pivot transform).

public const string RtcpSection = "Rtcp"

Field Value

string

ShortestKey

Key of the boolean inside RotaryWrapSection.

public const string ShortestKey = "Shortest"

Field Value

string

Properties

Name

Syntax kind name (typically the concrete type name).

public string Name { get; }

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