Class ProgramXyzSyntax

Namespace

Hi.NcParsers.LogicSyntaxs

Assembly

HiMech.dll

Compute MachineCoordinate and ProgramXyz (leaf coordinate) from syntax XYZ tags. Writes individual double components to SyntaxPiece.JsonObject under MachineCoordinate and ProgramXyz sub-objects. Must be placed after BundleSyntax since it uses cross-node lookback for last position.

public class ProgramXyzSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource

Inheritance

object

ProgramXyzSyntax

Implements

ISituNcSyntax

INcSyntax

IMakeXmlSource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Remarks

The term “Program” is absolute positioning coordinate that can be end-user editing. The coordinate is usually the final node from the chain of coordinate transformation.

Constructors

ProgramXyzSyntax()

public ProgramXyzSyntax()

ProgramXyzSyntax(XElement)

public ProgramXyzSyntax(XElement src)

Parameters

src XElement

Properties

AvailableJsonPathList

Available Json Path List to resolve semantic. Each path is a list of segments navigating nested JSON objects. Empty list means root level.

public List<List<string>> AvailableJsonPathList { get; }

Property Value

List<List<string>>

Examples

[["L"]]       → fullJsonSrc["L"]
[[]]          → fullJsonSrc (root)
[["L"], []]   → try fullJsonSrc["L"], fallback to root

Name

public string Name { get; }

Property Value

string

XName

public static string XName { get; }

Property Value

string

Methods

Build(LazyLinkedListNode<SyntaxPiece>, List<INcDependency>)

Build syntax arrangement into the syntaxPieceNode in-place.

public void Build(LazyLinkedListNode<SyntaxPiece> syntaxPieceNode, List<INcDependency> ncDependencyList)

Parameters

syntaxPieceNode LazyLinkedListNode<SyntaxPiece>

ncDependencyList List<INcDependency>

GetVec3d(JsonObject, string)

Read Vec3d from a sub-object with X/Y/Z keys.

public static Vec3d GetVec3d(JsonObject json, string sectionKey)

Parameters

json JsonObject

sectionKey string

Returns

Vec3d

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.