Table of Contents

Class NcCodeCommand

Namespace
Hi.SessionCommands
Assembly
HiNc.dll

Command for executing NC code directly.

[CultureText("zh-Hant", "NC程式碼")]
[CultureText("zh-Hans", "NC代码")]
[CommandCatalog(CommandCategory.Program, Order = 1)]
public class NcCodeCommand : ITitleCommand, ISessionCommand, IMakeXmlSource
Inheritance
NcCodeCommand
Implements
Inherited Members
Extension Methods

Constructors

NcCodeCommand()

Ctor.

public NcCodeCommand()

NcCodeCommand(string)

Initializes a new instance of the NcCodeCommand class with the specified NC text.

public NcCodeCommand(string nc)

Parameters

nc string

The NC code text.

NcCodeCommand(XElement, string)

Ctor.

public NcCodeCommand(XElement src, string baseDirectory)

Parameters

src XElement

XML

baseDirectory string

Base directory for resolving relative paths

Fields

ConstDisplayName

The command's own name — the DisplayNameAttribute value, the localization key, AND the Title default, which is why GetCommandTitle(ICommandTextSource) can treat a Title equal to it as unset.

public const string ConstDisplayName = "NC Code"

Field Value

string

Properties

NcText

The NC code text content.

public string NcText { get; set; }

Property Value

string

Title

Title. Alternative file name for the NC code file — it doubles as the in-memory NC program name handed to RunNc(string, string), so the default is a usable name rather than an empty string.

public string Title { get; set; }

Property Value

string

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

GetCommandTitle(ICommandTextSource)

Gets the title of the command — one row in a command list or a mission tree — composed from the caller's vocabulary: the command owns the composition and degradation rules, the caller owns the language.

The shape is Name, or Name [detail] once there is a detail worth showing. The NAME always leads and is never dropped: a row must say WHAT it is even when the detail is a title the user wrote, otherwise a newcomer cannot tell a command list from a script. The detail trails because these rows truncate from the right. An empty detail takes the bare-name form rather than rendering dangling brackets. 

public string GetCommandTitle(ICommandTextSource text)

Parameters

text ICommandTextSource

Culture-bearing vocabulary the static words are taken from.

Returns

string

The command title.

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

Run(SessionShell)

Runs the command, delegating execution to the provided session shell.

public IEnumerable<Action> Run(SessionShell sessionShell)

Parameters

sessionShell SessionShell

Session shell that exposes the machining facade to commands.

Returns

IEnumerable<Action>

Sequence of actions to be executed.