Class NcFileCommand

Namespace

Hi.ShellCommands

Assembly

HiNc.dll

Command for executing NC code from a file.

public class NcFileCommand : ITitleCommand, IShellCommand, IMakeXmlSource

Inheritance

object

NcFileCommand

Implements

ITitleCommand

IShellCommand

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)

Constructors

NcFileCommand()

Default constructor.

public NcFileCommand()

NcFileCommand(string)

public NcFileCommand(string ncFile)

Parameters

ncFile string

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 file.

public string NcFile { get; set; }

Property Value

string

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

GetCommandTitle()

public string GetCommandTitle()

Returns

string

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.

Run(RuntimeController)

Runs the command using the provided script API.

public IEnumerable<Action> Run(RuntimeController scriptApi)

Parameters

scriptApi RuntimeController

Script API for executing milling commands.

Returns

IEnumerable<Action>

Sequence of actions to be executed.