Table of Contents

Class RecordRuntimeGeomCommand

Namespace
Hi.ShellCommandUtils
Assembly
HiNc.dll

Command for recording runtime geometry to/from file.

public class RecordRuntimeGeomCommand : IShellCommand, IMakeXmlSource
Inheritance
RecordRuntimeGeomCommand
Implements
Inherited Members
Extension Methods

Constructors

RecordRuntimeGeomCommand()

Default constructor.

public RecordRuntimeGeomCommand()

RecordRuntimeGeomCommand(XElement, string)

Ctor.

public RecordRuntimeGeomCommand(XElement src, string baseDirectory)

Parameters

src XElement

XML

baseDirectory string

Base directory for resolving relative paths

Properties

MainActionEnum

Main action to perform (read, write, or conditional).

public RecordRuntimeGeomActionEnum MainActionEnum { get; set; }

Property Value

RecordRuntimeGeomActionEnum

RelFile

Relative file path.

public string RelFile { get; set; }

Property Value

string

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

MakeXmlSource(string, string)

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)

Parameters

baseDirectory string

The base directory for resolving relative paths

relFile string

The relative file path for the XML source

Returns

XElement

An XML element representing the object's state

Run(ShellApi)

Runs the command using the provided script API.

public IEnumerable<Action> Run(ShellApi scriptApi)

Parameters

scriptApi ShellApi

Script API for executing milling commands.

Returns

IEnumerable<Action>

Sequence of actions to be executed.