Class WriteShotFilesCommand

Namespace

Hi.ShellCommandUtils

Assembly

HiNc.dll

Command to call WriteShotFiles(string, double).

public class WriteShotFilesCommand : IShellCommand, IMakeXmlSource

Inheritance

object

WriteShotFilesCommand

Implements

IShellCommand

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

WriteShotFilesCommand()

Default constructor.

public WriteShotFilesCommand()

WriteShotFilesCommand(XElement, string)

Ctor.

public WriteShotFilesCommand(XElement src, string baseDirectory)

Parameters

src XElement

XML

baseDirectory string

Base directory for resolving relative paths

Properties

RelFileTemplate

Template for the relative file path where shot files will be written.

public string RelFileTemplate { get; set; }

Property Value

string

TimeResolution_ms

Time resolution in milliseconds for shot data sampling.

public double TimeResolution_ms { get; set; }

Property Value

double

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

MakeXmlSource(string, string)

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)

Parameters

baseDirectory string

The base directory for resolving relative paths

relFile string

The relative file path for the XML source

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.

Run(ShellApi)

Runs the command using the provided script API.

public IEnumerable<Action> Run(ShellApi scriptApi)

Parameters

scriptApi ShellApi

Script API for executing milling commands.

Returns

IEnumerable<Action>

Sequence of actions to be executed.