Class PostExecutionCommand

Namespace

Hi.SessionCommands

Assembly

HiNc.dll

Runs the outputs of a play – the step and shot files, the optimized and the converted programs, the geometry difference – on what the commands above it in the mission have played, at the moment it runs. It is not a hook at the end of the mission: a program below it is not covered, so place it after the program commands it is to cover. A session played again without a reset still holds the earlier play's steps, and the step and shot writers walk them too: a program whose steps run on unbroken from the earlier play's keeps both plays in its file, while a file whose program resumes after another program's steps is opened afresh there and keeps only the later play's (see StepFileTemplate). The outputs run one after another as the command is enumerated, with no pace point between them, so they come from one state of the session: a Pause, or a job queued for the run's next pace point (a step-physics recompute), waits past the last of them for the run's next pace point – after the first action a later row hands the player, or inside a later script's play. With no pace point after them – the mission's last row, where a new project puts this command – a Pause holds nothing and the run finishes, and a queued job runs at the run's end. A Stop during one output ends the run before the next, the player seeing it at the null the command yields after each output.

[CultureText("zh-Hant", "執行後處理")]
[CultureText("zh-Hans", "执行后处理")]
[CultureText("vi", "Sau khi thực thi")]
[CultureText("ja", "実行後処理")]
[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)

KindNameUtil.KindName(object)

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: relative to the project folder (an absolute path is used as it is); [NcName] is replaced by the file name of the program the steps were played from, extension kept (circle.ptp gives Output/circle.ptp.shot.csv); one file per program, opened afresh – truncated – each time the steps turn to that program from another one, so a program whose steps resume after another's (a subprogram called again, a program played again after another) keeps only its last stretch.

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: relative to the project folder (an absolute path is used as it is); [NcName] is replaced by the file name of the program the steps were played from, extension kept (circle.ptp gives Output/circle.ptp.step.csv); one file per program, opened afresh – truncated – each time the steps turn to that program from another one, so a program whose steps resume after another's (a subprogram called again, a program played again after another) keeps only its last stretch.

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. A command may do its work as it is enumerated and yield null between the pieces of it. The player invokes each action in order and paces after it – a Pause holds there, jobs queued for the run's pace point run there, and a Stop of its run ends the run there – and it ends a stopped run at a null item too, and before the next row of a ListCommand. An action is not checked for a Stop before it runs: one handed over after the Stop runs, and the run ends at the pace after it. Where the run ends, the player disposes the enumeration: the command's code after that item does not run, and what must run whatever happens belongs in a finally of the iterator. An exception that leaves the enumeration while the run is live ends the run as a fault: the player reports it as Player-Run–Fault, the run ends there as not finished, and no later row of a ListCommand runs; a command that catches and reports its own failure (a ScriptCommand‘s ScriptCommand-Run–Fault, the CSV mapping commands’ Map-SingleCsv–Fault and Map-SeriesCsv–Fault) lets the mission go on. Once the run is stopped, whatever leaves the enumeration – the run's own cancellation, or an exception its unwinding throws – is the Stop, and no message is said for it. A command that catches and reports its own failure still says it after the Stop: a ScriptCommand reports any exception other than a cancellation that comes out of its script's body – the body's own, or one the stopped run's unwinding throws inside the body – as ScriptCommand-Run–Fault, and the CSV mapping commands' catches let a cancellation through alone; the stopped run then starts no later row.