Class PostExecutionCommand

Namespace

Hi.SessionCommands

Assembly

HiNc.dll

Command for post-execution actions after NC command running.

[CultureText("zh-Hant", "執行後處理")]
[CultureText("zh-Hans", "执行后处理")]
[CommandCatalog(CommandCategory.Output, Order = 0)]
public class PostExecutionCommand : ITitleCommand, ISessionCommand, IMakeXmlSource

Inheritance

object

PostExecutionCommand

Implements

ITitleCommand

ISessionCommand

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

PostExecutionCommand()

Ctor.

public PostExecutionCommand()

PostExecutionCommand(XElement, string, string, params object[])

Ctor.

public PostExecutionCommand(XElement src, string baseDirectory, string relFile, params object[] res)

Parameters

src XElement

XML

baseDirectory string

Base directory for relative paths

relFile string

Relative file path

res object[]

Additional resources

Properties

ClToNcFileTemplate

Gets or sets the writeback output template; [NcName] is replaced by the source file name (extension kept).

public string ClToNcFileTemplate { get; set; }

Property Value

string

EnableConvertClToNcFiles

Gets or sets whether to convert the session's play into NC files by writeback synthesis (ConvertClToNcFiles(string)). Converts EVERY NC program file the session played (grouped per source file) — meaningful after a CL play; an NC play would be re-serialized too.

public bool EnableConvertClToNcFiles { get; set; }

Property Value

bool

EnableGeomDiff

Gets or sets whether to enable geometry difference detection.

public bool EnableGeomDiff { get; set; }

Property Value

bool

EnableOptimizeToFiles

Gets or sets whether to enable optimization to files.

public bool EnableOptimizeToFiles { get; set; }

Property Value

bool

EnableWriteShotFiles

Gets or sets whether to write shot files.

public bool EnableWriteShotFiles { get; set; }

Property Value

bool

EnableWriteStepFiles

Gets or sets whether to write step files.

public bool EnableWriteStepFiles { get; set; }

Property Value

bool

GeomDiffDetectRadius_mm

Gets or sets the geometry difference detection radius in millimeters.

public double GeomDiffDetectRadius_mm { get; set; }

Property Value

double

OptimizationFileTemplate

Gets or sets the optimization file template path.

public string OptimizationFileTemplate { get; set; }

Property Value

string

ShotFileTemplate

Gets or sets the shot file template path.

public string ShotFileTemplate { get; set; }

Property Value

string

ShotFileTimeResolution_ms

Gets or sets the time resolution for shot files in milliseconds.

public double ShotFileTimeResolution_ms { get; set; }

Property Value

double

StepFileTemplate

Gets or sets the step file template path.

public string StepFileTemplate { 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.