Table of Contents

Class HeidenhainCycleRetractSyntax

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

Consumes the Parsing.M140 record that HeidenhainMFunctionSyntax deferred on a may-fire-cycle block — a CYCL CALL [POS] host (… M140 MB+n is a real house.H shape), an M99/M89 flag block, or any block under armed M89 modality. WriteCompoundMotion(JsonObject, string, JsonArray, Vec3d) destroys any pre-written MotionEvent, so the retract is appended after the cycle expansion instead:

  • Cycle expanded — a rapid item to (final X, final Y, retract Z) is appended to the CompoundMotion items and the block's final ProgramXyz is lifted to the retract plane. The MB math is ResolveRetractTargetZ(JsonObject, Vec3d, List<INcDependency>, ISentenceCarrier, NcDiagnosticProgress) verbatim. The real TNC runs M140 at block start (retract, then position + cycle); appending it is a transient-only divergence — the endpoint chain re-anchors on the next command point (the P3 PLANE MOVE precedent) and the appended order is the safer trajectory. An F on the M140 is recorded on the item but the appended retract stays rapid (corpus M140-on-call blocks are all F-less).
  • Cycle did not expand (call consumed without motion) — the plain HeidenhainMFunctionSyntax retract behavior runs here unchanged, so a fail-soft call never silently drops the retract.
Must run after the shared cycle syntaxes (DrillingCycleSyntax/PeckDrillingCycleSyntax) and before McXyzSyntax. 
public class HeidenhainCycleRetractSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource
Inheritance
HeidenhainCycleRetractSyntax
Implements
Inherited Members
Extension Methods

Constructors

HeidenhainCycleRetractSyntax()

Initializes a new instance with default settings.

public HeidenhainCycleRetractSyntax()

HeidenhainCycleRetractSyntax(XElement)

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

public HeidenhainCycleRetractSyntax(XElement src)

Parameters

src XElement

Source XML element.

Fields

RetractZKey

Record key of the appended retract plane (program Z) on the call record.

public const string RetractZKey = "RetractZ"

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