Class ClsfRunnerConfig

Namespace

Hi.Numerical.ClsfParsers

Assembly

HiMech.dll

Configuration dependency for the NX-CL (CLSF) runner: the rapid traverse rate (a CLSF has no machine axes, so RAPID timing needs an assumed rate), the tool-creation policy, and the intentionally skipped record words. Also serves as the pipeline's IRapidFeedrateConfig so the machine-coordinate motion semantics reused from the NC pipeline (McLinearMotionSemantic, ClLinearMcMotionSemantic) time rapids from the same assumed rates — axis-uniform: every linear axis gets RapidFeedrate_mmdmin, every rotary axis RotaryRapidFeedrate_degdmin.

public class ClsfRunnerConfig : IRapidFeedrateConfig, INcDependency, IMakeXmlSource

Inheritance

object

ClsfRunnerConfig

Implements

IRapidFeedrateConfig

INcDependency

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

ClsfRunnerConfig()

Creates a config with default values.

public ClsfRunnerConfig()

ClsfRunnerConfig(XElement)

Reconstructs a config from its XML element.

public ClsfRunnerConfig(XElement src)

Parameters

src XElement

XML element previously produced by MakeXmlSource(string, string, bool).

Properties

ExcludedWords

Record words consumed silently as intentional skips (matched case-insensitively; multi-word heads like TOOL PATH included).

public List<string> ExcludedWords { get; set; }

Property Value

List<string>

PreferToolHouse

When true (default), a LOAD/TOOL id already present in the tool house keeps the configured tool and the CLSF TLDATA geometry is ignored; when false, TLDATA geometry overwrites the tool-house entry on every load.

public bool PreferToolHouse { get; set; }

Property Value

bool

RapidFeedrate_mmdmin

Assumed rapid traverse rate in mm/min used to time RAPID moves.

public double RapidFeedrate_mmdmin { get; set; }

Property Value

double

RotaryRapidFeedrate_degdmin

Assumed rotary rapid traverse rate in deg/min, used by the reused MC motion semantics to time rotary-dominated rapids on an MC machine.

public double RotaryRapidFeedrate_degdmin { get; set; }

Property Value

double

XName

XML element name used to register this dependency with XFactory.

public static string XName { get; }

Property Value

string

Methods

GetLinearAxisRapidRate_mmdmin(string)

Gets rapid traverse feedrate for a linear axis in mm/min. Returns a default value if the axis is not configured.

public double GetLinearAxisRapidRate_mmdmin(string axisName)

Parameters

axisName string

Returns

double

GetRotaryAxisRapidRate_degdmin(string)

Gets rapid traverse feedrate for a rotary axis in deg/min. Returns a default value if the axis is not configured.

public double GetRotaryAxisRapidRate_degdmin(string axisName)

Parameters

axisName string

Returns

double

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

SetLinearAxisRapidRate_mmdmin(string, double)

Sets rapid traverse feedrate for a linear axis in mm/min.

public void SetLinearAxisRapidRate_mmdmin(string axisName, double value)

Parameters

axisName string

value double

SetRotaryAxisRapidRate_degdmin(string, double)

Sets rapid traverse feedrate for a rotary axis in deg/min.

public void SetRotaryAxisRapidRate_degdmin(string axisName, double value)

Parameters

axisName string

value double