Table of Contents

Class McXyzSyntax

Namespace
Hi.NcParsers.LogicSyntaxs
Assembly
HiMech.dll

Derives MachineCoordinateState from ProgramXyz by applying the composed ProgramToMcTransform.

Processes two stages:

  1. Root ProgramXyz → root MachineCoordinate
  2. CompoundMotion.ItemsKey[*] — derives MachineCoordinate from ProgramXyz for items that have ProgramXyz but no MachineCoordinate
Must be placed after syntaxes that write ProgramXyz (e.g., ReferenceReturnSyntax) and before syntaxes that read MachineCoordinate (e.g., LinearMotionSyntax).
public class McXyzSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource
Inheritance
McXyzSyntax
Implements
Inherited Members
Extension Methods

Examples

Root ProgramXyz only, no ProgramToMcTransform chain — composed transform is identity, so MC equals ProgramXyz: #BeforeBuild:

{ "ProgramXyz": { "X": 10, "Y": 20, "Z": 30 } }

#AfterBuild:

{
  "ProgramXyz": { "X": 10, "Y": 20, "Z": 30 },
  "MachineCoordinateState": { "X": 10, "Y": 20, "Z": 30 }
}

Root MachineCoordinateState already present — guarded by the non-null check, so an upstream syntax's explicit MC is preserved verbatim (the derivation from ProgramXyz is skipped): #BeforeBuild:

{
  "ProgramXyz": { "X": 10, "Y": 20, "Z": 30 },
  "MachineCoordinateState": { "X": 100, "Y": 200, "Z": 300 }
}

#AfterBuild:

{
  "ProgramXyz": { "X": 10, "Y": 20, "Z": 30 },
  "MachineCoordinateState": { "X": 100, "Y": 200, "Z": 300 }
}

CompoundMotion.Items[*] with ProgramXyz but no MachineCoordinateState — each item receives its own derived MC; items that already had MC (or had no ProgramXyz) are left alone: #BeforeBuild:

{
  "CompoundMotion": {
    "Items": [
      { "ProgramXyz": { "X": 1, "Y": 2, "Z": 3 } },
      { "MachineCoordinateState": { "X": 9, "Y": 9, "Z": 9 } }
    ]
  }
}

#AfterBuild:

{
  "CompoundMotion": {
    "Items": [
      {
        "ProgramXyz": { "X": 1, "Y": 2, "Z": 3 },
        "MachineCoordinateState": { "X": 1, "Y": 2, "Z": 3 }
      },
      { "MachineCoordinateState": { "X": 9, "Y": 9, "Z": 9 } }
    ]
  }
}

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