Class ScriptCommand

Namespace

Hi.SessionCommands

Assembly

HiNc.dll

Command for executing C# scripts in the milling process.

public class ScriptCommand : ITitleCommand, ISessionCommand, IMakeXmlSource, IGetSelectionName

Inheritance

object

ScriptCommand

Implements

ITitleCommand

ISessionCommand

IMakeXmlSource

IGetSelectionName

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

ScriptCommand()

Ctor.

public ScriptCommand()

ScriptCommand(XElement, string)

Ctor.

public ScriptCommand(XElement src, string baseDirectory)

Parameters

src XElement

XML

baseDirectory string

Base directory for resolving relative paths

Properties

ExecutionTemplate

Gets the execution template command.

public static ScriptCommand ExecutionTemplate { get; }

Property Value

ScriptCommand

OptimizationConfigurationTemplate

Gets the optimization configuration template command.

public static ScriptCommand OptimizationConfigurationTemplate { get; }

Property Value

ScriptCommand

PreSettingTemplate

Gets the pre-setting template command.

public static ScriptCommand PreSettingTemplate { get; }

Property Value

ScriptCommand

ScriptText

The script text content.

public string ScriptText { get; set; }

Property Value

string

ScriptTitle

Title or name of the script.

public string ScriptTitle { get; set; }

Property Value

string

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

GenTemplateCommand()

Generates a template script command with default values.

public static ScriptCommand GenTemplateCommand()

Returns

ScriptCommand

A new ScriptCommand with template values

GetCommandTitle()

Gets the title of the command.

public string GetCommandTitle()

Returns

string

The command title.

GetSelectionName()

Gets a name that can be used for selection in UI or other contexts.

public string GetSelectionName()

Returns

string

The selection name for this object

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 (and its legacy alias) 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.

Run(SessionShell, string)

Runs a specified script with the given session shell.

public IEnumerable<Action> Run(SessionShell sessionShell, string scriptText)

Parameters

sessionShell SessionShell

The session shell that scripts delegate to.

scriptText string

The script text to run

Returns

IEnumerable<Action>

Enumerable of actions to perform