Class MapSingleCsvConfig

Namespace

Hi.Mapping

Assembly

HiMech.dll

Column titles of the CSV file read by MapSingleByCsvFile(ClStrip, string, string, IProgress<IMessage>, Func<DateTime, TimeSpan>, MapSingleCsvConfig) (the one-step-one-data mapping). One tag per column the reader looks up, each defaulting to the MappingUtil title the step-file writer emits, so a default instance reads exactly what the reader read before the titles became configurable. A blank tag falls back to that default.

public class MapSingleCsvConfig : IMakeXmlSource

Inheritance

object

MapSingleCsvConfig

Implements

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)

Remarks

The reader takes the step time from the first usable source in this order: ActualTimecodeTag (with the optional ActualDateTimeTag companion), then ActualTimeTag, then SimTimeTag. A controller log that carries one time column is mapped by naming it in ActualTimeTag, whose cell may be a timecode or an absolute date-time. Every column no tag names is embedded onto the steps under its own title.

Constructors

MapSingleCsvConfig()

Default constructor.

public MapSingleCsvConfig()

MapSingleCsvConfig(XElement)

Constructor from XML. An absent element keeps its default tag.

public MapSingleCsvConfig(XElement src)

Parameters

src XElement

XML element; null yields the defaults

Properties

ActualDateTimeTag

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

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.

public string ActualTimeTag { get; set; }

Property Value

string

ActualTimecodeTag

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

public string ActualTimecodeTag { get; set; }

Property Value

string

FileNoTag

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

public string FileNoTag { get; set; }

Property Value

string

LineNoTag

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

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.

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

public string SimTimeTag { get; set; }

Property Value

string

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

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.