Class MapSeriesCsvConfig

Namespace

Hi.Mapping

Assembly

HiMech.dll

Column titles of the time-series (shot) CSV file read by MapSeriesByActualTime(string, CycleSamplingMode, ClStrip, IProgress<IMessage>, CancellationToken?, Range<int>, MapSeriesCsvConfig) (the one-step-many-data mapping). One tag per column the reader looks up.

public class MapSeriesCsvConfig : IMakeXmlSource

Inheritance

object

MapSeriesCsvConfig

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)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Remarks

A tag left at its default also accepts the built-in titles of that column (TimeTags, FxTags and so on), and every data column stays optional — an absent one reads as NaN. A tag changed to another title is looked up exactly, and the file must carry that column: a title row without it is refused by name, so a mistyped title cannot pass for an absent sensor channel. A blank tag counts as left at its default.

Constructors

MapSeriesCsvConfig()

Default constructor.

public MapSeriesCsvConfig()

MapSeriesCsvConfig(XElement)

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

public MapSeriesCsvConfig(XElement src)

Parameters

src XElement

XML element; null yields the defaults

Properties

AxTag

Title of the X acceleration column (g).

public string AxTag { get; set; }

Property Value

string

AyTag

Title of the Y acceleration column (g).

public string AyTag { get; set; }

Property Value

string

AzTag

Title of the Z acceleration column (g).

public string AzTag { get; set; }

Property Value

string

FxTag

Title of the X force column (N).

public string FxTag { get; set; }

Property Value

string

FyTag

Title of the Y force column (N).

public string FyTag { get; set; }

Property Value

string

FzTag

Title of the Z force column (N).

public string FzTag { get; set; }

Property Value

string

IsDefault

True when every tag is left at its default, i.e. the file reads the same as with no configuration at all.

public bool IsDefault { get; }

Property Value

bool

MxTag

Title of the X moment column (N·m).

public string MxTag { get; set; }

Property Value

string

MyTag

Title of the Y moment column (N·m).

public string MyTag { get; set; }

Property Value

string

MzTag

Title of the Z moment column (N·m).

public string MzTag { get; set; }

Property Value

string

TimeTag

Title of the sample time column (seconds, a timecode, or an absolute date-time cell). Required.

public string TimeTag { get; set; }

Property Value

string

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

Clone()

A copy that later edits of this instance do not reach — what a reading in flight holds, since an editor may change the tags of a live command at any moment.

public MapSeriesCsvConfig Clone()

Returns

MapSeriesCsvConfig

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.