Class NcOptProc

Namespace

Hi.NcOpt

Assembly

HiNc.dll

Provides functionality for optimizing NC programs by modifying feed rates and tool paths.

public class NcOptProc : IMakeXmlSource

Inheritance

object

NcOptProc

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)

Constructors

NcOptProc(SequentialBulkReader<MillingStepLuggage>)

Ctor.

public NcOptProc(SequentialBulkReader<MillingStepLuggage> millingStepLuggageReader)

Parameters

millingStepLuggageReader SequentialBulkReader<MillingStepLuggage>

NcOptProc(XElement, string, SequentialBulkReader<MillingStepLuggage>)

Ctor.

public NcOptProc(XElement src, string baseDirectory, SequentialBulkReader<MillingStepLuggage> millingStepLuggageReader)

Parameters

src XElement

XML

baseDirectory string

Base directory path

millingStepLuggageReader SequentialBulkReader<MillingStepLuggage>

Milling step luggage reader

Properties

CoreNum

Parallel computation thread num. 0 is special number to use all cores.

public static int CoreNum { get; set; }

Property Value

int

EmbeddedLogMode

Gets or sets the embedded log mode for NC optimization.

public static NcOptimizationEmbeddedLogMode EmbeddedLogMode { get; set; }

Property Value

NcOptimizationEmbeddedLogMode

EnableIndividualStepAdjustmentLog

Enable create log file for building individual NcOptProc.StepAdjustment process.

public static bool EnableIndividualStepAdjustmentLog { get; set; }

Property Value

bool

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

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.

Optimize(ICuttingPara, MachiningSession, LinkedList<HardNcLine>, HardNcEnv, List<MachiningStep>, MachiningToolHouse, IMessageHost, CancellationToken, string, string)

Optimizes NC lines based on cutting parameters and milling steps.

public IEnumerable<(HardNcLine SrcNcLine, HardNcLine OptNcLine)> Optimize(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList<HardNcLine> srcNcLines, HardNcEnv ncEnv, List<MachiningStep> machiningSteps, MachiningToolHouse millingToolHouse, IMessageHost messageHost, CancellationToken cancellationToken, string baseDirectory, string relFileTemplate)

Parameters

millingPara ICuttingPara

The cutting parameters for optimization.

machiningSession MachiningSession

The current machining session.

srcNcLines LinkedList<HardNcLine>

The source NC lines to optimize.

ncEnv HardNcEnv

The NC environment settings.

machiningSteps List<MachiningStep>

The list of milling steps.

millingToolHouse MachiningToolHouse

The machining tool house.

messageHost IMessageHost

The message host for logging.

cancellationToken CancellationToken

Cancellation token to cancel the operation.

baseDirectory string

The base directory for file operations.

relFileTemplate string

The relative file template for output.

Returns

IEnumerable<(HardNcLine SrcNcLine, HardNcLine OptNcLine)>

Enumerable of source and optimized NC line pairs.

OptimizeToFiles(ICuttingPara, MachiningSession, LinkedList<HardNcLine>, HardNcEnv, MachiningToolHouse, ClStrip, string, IMessageHost, CancellationToken, string)

Optimizes NC lines and writes the results to files.

public void OptimizeToFiles(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList<HardNcLine> ncLines, HardNcEnv ncEnv, MachiningToolHouse millingToolHouse, ClStrip clStrip, string baseDirectory, IMessageHost messageHost, CancellationToken cancellationToken, string relFileTemplate = "Output/Opt-[NcName]")

Parameters

millingPara ICuttingPara

The cutting parameters for optimization

machiningSession MachiningSession

The current machining session

ncLines LinkedList<HardNcLine>

The NC lines to optimize

ncEnv HardNcEnv

The NC environment settings

millingToolHouse MachiningToolHouse

The machining tool house

clStrip ClStrip

The cutter location strip

baseDirectory string

The base directory for output files

messageHost IMessageHost

The message host for logging

cancellationToken CancellationToken

Cancellation token to cancel the operation

relFileTemplate string

The relative file template for output files