SessionShell

SessionShell is the global scope of the HiNC scripting engine: a script names its members directly, with no object reference and no using. Everything a script does to a session — start a playback, set a resolution, export a file, train a coefficient, read a step — is a member of this one type.

The complete and current list of commands, properties and events is the generated SessionShell reference. This page is the map onto it — which family does what, and which workflow reaches for it. The members are deliberately not re-listed here: a hand-copied index of an API drifts the moment the API changes, and nothing in the build can catch it.

Command Families

Family	What it does	Where it is used
Playback	Runs a program — NC files and NC strings, CSV-driven playback, cutter-location files, and tool teleports. Parse-only variants return the action sequence without pacing it.	Workflow: Basic Machining Simulation, Cutter-Location (CL) Playback
Player control	Paces, pauses and resets the running player: the checkpoints a script inserts into a playback.	Workflow: Basic Machining Simulation
Resolution and cache	Workpiece entity resolution, motion resolution mode, display cache size. The largest single influence a script has on run time.	Workflow: Basic Machining Simulation, CPU Usage During Simulation
Physics switches	Whether milling force, wear effect and collision detection are evaluated; angular divisions per revolution; initial spindle temperature; whether a failure or a collision pauses the run.	Workflow: Milling Force Parameter Training, Workflow: Geometry Validation
Data export	Step-level CSV and waveform (shot) CSV, both accepting the `[NcName]` template.	Workflow: Basic Machining Simulation, Workflow: Milling Force Parameter Training
Sensor mapping	Puts measured data alongside the simulated run: one-to-one and series mapping from CSV, time-range selection written into NC comments, and clearing what was mapped.	Workflow: Sensor Data Mapping
Training	Trains milling coefficients from mapped data, calibrates existing ones, and loads cutting parameters into the workpiece.	Workflow: Milling Force Parameter Training
Optimization	The optimizer's file output and its whole settings surface — feed-rate and re-interpolation switches, feed and acceleration limits, the four safety factors, the target force, the preserve ranges that exempt lines, and the per-step log.	Workflow: NC Optimization
Geometry	Reads, writes and exports meshed geometry (STL / OBJ / PLY), compares the cut against a target, removes disconnected residual material, and scans for defects.	Workflow: Geometry Validation
Messages	The four message severities and the file export, all routed through ShellProgress.	all workflows
Step access	Reads a step by index, reports the step count, and registers custom step variables.	Step
Events	Per-step hooks that fire as a step is built or selected.	Workflow: NC Optimization
Runtime management	Clears event handlers, buffers and runtime state, and carries data between scripts through the `Global` dictionary.	Script Commands
Tool setup	Adjusts contour shift angle and smart-holder observation height at run time.	Smart Tool Holder Coefficient Training

What the Generated Reference Does Not Say

Tool setup is for a mismatch, not for configuration. Those members exist for the case where the actual installation differs from the configured tool. Where the two agree, set the value in the tool configuration file instead — a script that sets it is silently overriding what everyone else reads.
The geometry family answers to hidden legacy names. WriteRuntimeGeom / ReadRuntimeGeom / ExportRuntimeGeomTo* / ScanRuntimeGeomInfDefect still run in existing player scripts as aliases of the MeshedGeom names; new scripts use the new names. The full mapping is in Renames with no shim.
Resetting the runtime does not clear the record. Event handlers, buffers and runtime state go; messages already recorded stay — see ShellProgress.

Table of Contents

SessionShell

Command Families

What the Generated Reference Does Not Say

See Also