Table of Contents

Class HeidenhainCyclCallSyntax

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

Captures the klartext cycle-call statement into a Parsing[“CYCL CALL”] record:

  • CYCL CALL — { Bare: true }; any trailing M words stay in the text for the shared flag captures.
  • CYCL CALL POS X±n Y±n Z±n … — { Pos: true } plus the axis words grabbed into the record (never onto the Parsing root: the POS coordinates are the call position — the X/Y feed the ISO cycle section, while the pre-position Z must not be mistaken for the hole-bottom Z slot). FMAX/F/M140 words stay in the text for their own captures.
The call is consumed by HeidenhainCannedCycleSyntax, which converts the stored cycle definition into a direct ISO cycle sub-section on this block. 
public class HeidenhainCyclCallSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource
Inheritance
HeidenhainCyclCallSyntax
Implements
Inherited Members
Extension Methods

Examples

Bare call — trailing M words stay for the shared flag capture: #BeforeBuild.UnparsedText: CYCL CALL M13 #AfterBuild:

{
  "UnparsedText": "M13",
  "Parsing": { "CYCL CALL": { "Bare": true } }
}

Positional call — axis words land inside the record; FMAX stays: #BeforeBuild.UnparsedText: CYCL CALL POS X-14 Y+25 Z+0 FMAX #AfterBuild:

{
  "UnparsedText": "FMAX",
  "Parsing": { "CYCL CALL": { "Pos": true, "X": -14, "Y": 25, "Z": 0 } }
}

Constructors

HeidenhainCyclCallSyntax()

Initializes a new instance with default settings.

public HeidenhainCyclCallSyntax()

HeidenhainCyclCallSyntax(XElement)

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

public HeidenhainCyclCallSyntax(XElement src)

Parameters

src XElement

Source XML element.

Fields

BareKey

Record key marking the bare (positionless) call form.

public const string BareKey = "Bare"

Field Value

string

CyclCallKey

JSON key of the call record under Parsing.

public const string CyclCallKey = "CYCL CALL"

Field Value

string

PatKey

Record key marking the CYCL CALL PAT (pattern) form.

public const string PatKey = "Pat"

Field Value

string

PosKey

Record key marking the CYCL CALL POS form.

public const string PosKey = "Pos"

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