Class NcOptOptionCommand

Namespace

Hi.SessionCommands

Assembly

HiNc.dll

Command for NC optimization options.

public class NcOptOptionCommand : ITitleCommand, ISessionCommand, IMakeXmlSource

Inheritance

object

NcOptOptionCommand

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

NcOptOptionCommand()

Ctor.

public NcOptOptionCommand()

NcOptOptionCommand(XElement, string, string, IProgress<object>, object[])

Ctor.

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

Parameters

src XElement

XML

baseDirectory string

Base directory for relative paths

relFile string

Relative file path

progress IProgress<object>

Progress reporter for nested option XML.

res object[]

Additional resources

Properties

NcOptOption

Gets or sets the NC optimization options.

public NcOptOption NcOptOption { get; set; }

Property Value

NcOptOption

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.

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.