Class PreSettingCommand

Namespace

Hi.SessionCommands

Assembly

HiNc.dll

Legacy bundle of pre-settings applied before NC command running, superseded by the single-setting commands (machining resolution, motion resolution, collision detection, pause on failure, physics). Loading a project expands a saved instance into those commands via ExpandToEntries(bool); saving never writes the bundle back. The class stays functional for API callers that construct it directly.

[CultureText("zh-Hant", "一般設定")]
[CultureText("zh-Hans", "一般设定")]
public class PreSettingCommand : ITitleCommand, ISessionCommand, IMakeXmlSource

Inheritance

object

PreSettingCommand

Implements

ITitleCommand

ISessionCommand

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, IProgress<IMessage>, object[])

Ctor.

public PreSettingCommand(XElement src, string baseDirectory, string relFile, IProgress<IMessage> progress, object[] res)

Parameters

src XElement

XML

baseDirectory string

Base directory for relative paths

relFile string

Relative file path

progress IProgress<IMessage>

Progress reporter for nested preset XML.

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

EnableReadMeshedGeom

Gets or sets whether to enable reading meshed geometry.

public bool EnableReadMeshedGeom { 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

MeshedGeomFile

Gets or sets the meshed geometry file path.

public string MeshedGeomFile { get; set; }

Property Value

string

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

ExpandToEntries(bool)

Expands this bundle into the split single-setting commands, in the order the bundle applied them. isEnabled — the enable state of the bundle's own list entry — is consumed into every split entry; the meshed-geometry read additionally keeps its own EnableReadMeshedGeom flag (its entry is emitted only when the read is enabled or a file is set, as a RecordMeshedGeomCommand in Read mode).

public List<EnablingWrapper> ExpandToEntries(bool isEnabled)

Parameters

isEnabled bool

Enable state of the bundle's list entry.

Returns

List<EnablingWrapper>

The split entries replacing the bundle.

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.