Class PreSettingCommand

Namespace

Hi.ShellCommands

Assembly

HiNc.dll

Command for pre-settings before NC command running.

public class PreSettingCommand : ITitleCommand, IShellCommand, IMakeXmlSource

Inheritance

object

PreSettingCommand

Implements

ITitleCommand

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

PreSettingCommand()

Ctor.

public PreSettingCommand()

PreSettingCommand(XElement, string, string, params object[])

Ctor.

public PreSettingCommand(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

EnableCollisionDetection

Gets or sets whether collision detection is enabled.

public bool EnableCollisionDetection { get; set; }

Property Value

bool

EnablePauseOnFailure

Gets or sets whether to pause on failure.

public bool EnablePauseOnFailure { get; set; }

Property Value

bool

EnablePhysics

Gets or sets whether physics is enabled.

public bool EnablePhysics { get; set; }

Property Value

bool

EnableReadRuntimeGeom

Gets or sets whether to enable reading runtime geometry.

public bool EnableReadRuntimeGeom { get; set; }

Property Value

bool

MachiningMotionResolution

Gets or sets the machining motion resolution.

public IMachiningMotionResolution MachiningMotionResolution { get; set; }

Property Value

IMachiningMotionResolution

MachiningResolution_mm

Gets or sets the machining resolution in millimeters.

public double MachiningResolution_mm { get; set; }

Property Value

double

RuntimeGeomFile

Gets or sets the runtime geometry file path.

public string RuntimeGeomFile { get; set; }

Property Value

string

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

GetCommandTitle()

Gets the title of the command.

public string GetCommandTitle()

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.

Run(RuntimeApi)

Runs the command using the provided script API.

public IEnumerable<Action> Run(RuntimeApi scriptApi)

Parameters

scriptApi RuntimeApi

Script API for executing milling commands.

Returns

IEnumerable<Action>

Sequence of actions to be executed.