Table of Contents

Class MapSingleByCsvFileCommand

Namespace
Hi.SessionCommands
Assembly
HiNc.dll

Command to call MapSingleByCsvFile(string, MapSingleCsvConfig): embeds one CSV row per step (one-to-one mapping) onto the steps played so far. Carries the column titles of its file (CsvConfig), so a controller log maps without renaming its columns first.

[CultureText("zh-Hant", "CSV 一對一映射")]
[CultureText("zh-Hans", "CSV 一对一映射")]
[CultureText("vi", "Ánh xạ một-một từ tệp CSV")]
[CultureText("ja", "CSV ファイルによる一対一の対応付け")]
[CommandCatalog(CommandCategory.Mapping, Order = 0)]
public class MapSingleByCsvFileCommand : ITitleCommand, ISessionCommand, IMakeXmlSource
Inheritance
MapSingleByCsvFileCommand
Implements
Inherited Members
Extension Methods

Constructors

MapSingleByCsvFileCommand()

Default constructor.

public MapSingleByCsvFileCommand()

MapSingleByCsvFileCommand(XElement, string)

Ctor.

public MapSingleByCsvFileCommand(XElement src, string baseDirectory)

Parameters

src XElement

XML

baseDirectory string

Base directory for resolving relative paths

Properties

ActualDateTimeTag

Title of the absolute controller-instant column that accompanies ActualTimecodeTag. Optional.

[CultureText("zh-Hant", "實際日期時間欄位", Key = "Actual Date-Time Column")]
[CultureText("zh-Hans", "实际日期时间列", Key = "Actual Date-Time Column")]
[CultureText("vi", "Cột ngày giờ thực tế", Key = "Actual Date-Time Column")]
[CultureText("ja", "実日時の列", Key = "Actual Date-Time Column")]
public string ActualDateTimeTag { get; set; }

Property Value

string

ActualTimeTag

Title of the single actual-time column (a timecode or an absolute date-time cell); the second time source tried.

[CultureText("zh-Hant", "實際時間欄位", Key = "Actual Time Column")]
[CultureText("zh-Hans", "实际时间列", Key = "Actual Time Column")]
[CultureText("vi", "Cột thời gian thực tế", Key = "Actual Time Column")]
[CultureText("ja", "実時刻の列", Key = "Actual Time Column")]
public string ActualTimeTag { get; set; }

Property Value

string

ActualTimecodeTag

Title of the run-relative actual timecode column; the first time source tried.

[CultureText("zh-Hant", "實際時間碼欄位", Key = "Actual Timecode Column")]
[CultureText("zh-Hans", "实际时间码列", Key = "Actual Timecode Column")]
[CultureText("vi", "Cột mã thời gian thực tế", Key = "Actual Timecode Column")]
[CultureText("ja", "実タイムコードの列", Key = "Actual Timecode Column")]
public string ActualTimecodeTag { get; set; }

Property Value

string

CsvConfig

Column titles of the file. The tag properties below are its faces for generic field editors. Null is the default titles.

public MapSingleCsvConfig CsvConfig { get; set; }

Property Value

MapSingleCsvConfig

FileNoTag

Title of the (1-based) file number column. Required.

[CultureText("zh-Hant", "檔案編號欄位", Key = "File Number Column")]
[CultureText("zh-Hans", "文件编号列", Key = "File Number Column")]
[CultureText("vi", "Cột số thứ tự tệp", Key = "File Number Column")]
[CultureText("ja", "ファイル番号の列", Key = "File Number Column")]
public string FileNoTag { get; set; }

Property Value

string

LineNoTag

Title of the (1-based) line number column. Required.

[CultureText("zh-Hant", "行號欄位", Key = "Line Number Column")]
[CultureText("zh-Hans", "行号列", Key = "Line Number Column")]
[CultureText("vi", "Cột số dòng", Key = "Line Number Column")]
[CultureText("ja", "行番号の列", Key = "Line Number Column")]
public string LineNoTag { get; set; }

Property Value

string

MachineCoordinatePrefix

Prefix of the machine-coordinate columns, composed as the prefix plus X, Y, Z, A, B, C.

[CultureText("zh-Hant", "機械座標前綴", Key = "Machine Coordinate Prefix")]
[CultureText("zh-Hans", "机械坐标前缀", Key = "Machine Coordinate Prefix")]
[CultureText("vi", "Tiền tố tọa độ máy", Key = "Machine Coordinate Prefix")]
[CultureText("ja", "機械座標のプレフィックス", Key = "Machine Coordinate Prefix")]
public string MachineCoordinatePrefix { get; set; }

Property Value

string

RelFile

Path of the CSV file, relative to the project directory.

[CultureText("zh-Hant", "CSV 檔案", Key = "CSV File")]
[CultureText("zh-Hans", "CSV 文件", Key = "CSV File")]
[CultureText("vi", "Tệp CSV", Key = "CSV File")]
[CultureText("ja", "CSV ファイル", Key = "CSV File")]
public string RelFile { get; set; }

Property Value

string

SimTimeTag

Title of the simulated end-timecode column; the last time source tried. Left at its default, the legacy SimTimeTagLegacy title is accepted too.

[CultureText("zh-Hant", "模擬時間欄位", Key = "Simulated Time Column")]
[CultureText("zh-Hans", "仿真时间列", Key = "Simulated Time Column")]
[CultureText("vi", "Cột thời gian mô phỏng", Key = "Simulated Time Column")]
[CultureText("ja", "シミュレーション時刻の列", Key = "Simulated Time Column")]
public string SimTimeTag { 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.