Table of Contents

Class NcFileCommand

Namespace
Hi.SessionCommands
Assembly
HiNc.dll

Command for executing an NC program file (Nc is the umbrella term: brand controller code, NX-CL or CSV). The runner is picked by NcKind — Auto (the default) detects by file extension: .cl/.cls/.clsf play as NX-CL, .csv as CSV, anything else as brand NC code. The GUI labels it “Program File”.

[CultureText("zh-Hant", "程式檔案")]
[CultureText("zh-Hans", "程序文件")]
[CommandCatalog(CommandCategory.Program, Order = 0)]
public class NcFileCommand : ITitleCommand, ISessionCommand, IMakeXmlSource
Inheritance
NcFileCommand
Implements
Inherited Members
Extension Methods

Constructors

NcFileCommand()

Default constructor.

public NcFileCommand()

NcFileCommand(string)

Initializes a new instance of the NcFileCommand class with the specified NC program file path.

public NcFileCommand(string ncFile)

Parameters

ncFile string

The NC program file path.

NcFileCommand(XElement, string)

Ctor.

public NcFileCommand(XElement src, string baseDirectory)

Parameters

src XElement

XML

baseDirectory string

Base directory for resolving relative paths

Properties

NcFile

Path to the NC program file.

public string NcFile { get; set; }

Property Value

string

NcKind

Which runner plays NcFile; Auto detects by extension.

public NcKind NcKind { get; set; }

Property Value

NcKind

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.