Table of Contents

Class NcResultEntry

Namespace
Hi.MachiningProcs
Assembly
HiNc.dll

One result folder as SessionShell.ListNcResults lists it: a sub-folder of the results directory that holds a result.db, with what the file says about itself when it opens – the program's name, when it was recorded, whether it is complete, whether the play ran to its end, the counts, whether values written after the play were taken in – else what refused it. A review opens the newest complete one by default; a folder named to it opens whether complete or not (an incomplete one with NcResult-Review–Incomplete).

public sealed record NcResultEntry : IEquatable<NcResultEntry>
Inheritance
NcResultEntry
Implements
Inherited Members
Extension Methods

Constructors

NcResultEntry(string, string, DateTime?, bool, bool?, int?, int?, int?, DateTime?, DateTime?, bool, bool, string)

One result folder as SessionShell.ListNcResults lists it: a sub-folder of the results directory that holds a result.db, with what the file says about itself when it opens – the program's name, when it was recorded, whether it is complete, whether the play ran to its end, the counts, whether values written after the play were taken in – else what refused it. A review opens the newest complete one by default; a folder named to it opens whether complete or not (an incomplete one with NcResult-Review–Incomplete).

public NcResultEntry(string Directory, string NcName, DateTime? CreatedUtc, bool IsFinalized, bool? PlayCompleted, int? StepCount, int? PositionCount, int? PieceCount, DateTime? ActualTimesAmendedUtc, DateTime? BriefsAmendedUtc, bool HasWct, bool IsNotResultFile, string Error)

Parameters

Directory string

The result folder's full path.

NcName string

The program the recording was named after; null when the file did not open.

CreatedUtc DateTime?

When the recording began, in UTC; null when the file did not open.

IsFinalized bool

Whether the file is complete: the kind a review opens by default (the newest complete one). False for a recording in progress (here or in another program), for an orphan – a recording that crashed or was abandoned, whose counts are null, or one whose completion was refused, whose counts are in – and for a file that did not open.

PlayCompleted bool?

Whether the recorded plays ran to their ends rather than being stopped or cut short; null for a recording that never wrote its counts.

StepCount int?

The steps recorded; null for a recording that never wrote its counts.

PositionCount int?

The toolpath positions recorded; null for a recording that never wrote its counts.

PieceCount int?

The program blocks recorded; null for a recording that never wrote its counts.

ActualTimesAmendedUtc DateTime?

When the measured times of a CSV mapping were last written into the file, in UTC; null when none were.

BriefsAmendedUtc DateTime?

When the briefs of a step-physics recompute were last written into the file, in UTC; null when none were.

HasWct bool

Whether the finished stock (finish.wct) lies beside the file.

IsNotResultFile bool

Whether the file was refused as no result file at all (another kind of SQLite file, truncated, corrupt): with Error saying why.

Error string

Why the file could not be opened (not a result file, truncated, locked); null when it opened.

Properties

ActualTimesAmendedUtc

When the measured times of a CSV mapping were last written into the file, in UTC; null when none were.

public DateTime? ActualTimesAmendedUtc { get; init; }

Property Value

DateTime?

BriefsAmendedUtc

When the briefs of a step-physics recompute were last written into the file, in UTC; null when none were.

public DateTime? BriefsAmendedUtc { get; init; }

Property Value

DateTime?

CreatedUtc

When the recording began, in UTC; null when the file did not open.

public DateTime? CreatedUtc { get; init; }

Property Value

DateTime?

DatabasePath

The full path of the folder's result.db.

public string DatabasePath { get; }

Property Value

string

Directory

The result folder's full path.

public string Directory { get; init; }

Property Value

string

Error

Why the file could not be opened (not a result file, truncated, locked); null when it opened.

public string Error { get; init; }

Property Value

string

HasWct

Whether the finished stock (finish.wct) lies beside the file.

public bool HasWct { get; init; }

Property Value

bool

IsFinalized

Whether the file is complete: the kind a review opens by default (the newest complete one). False for a recording in progress (here or in another program), for an orphan – a recording that crashed or was abandoned, whose counts are null, or one whose completion was refused, whose counts are in – and for a file that did not open.

public bool IsFinalized { get; init; }

Property Value

bool

IsNotResultFile

Whether the file was refused as no result file at all (another kind of SQLite file, truncated, corrupt): with Error saying why.

public bool IsNotResultFile { get; init; }

Property Value

bool

NcName

The program the recording was named after; null when the file did not open.

public string NcName { get; init; }

Property Value

string

Opened

Whether the file opened and read (Error null).

public bool Opened { get; }

Property Value

bool

PieceCount

The program blocks recorded; null for a recording that never wrote its counts.

public int? PieceCount { get; init; }

Property Value

int?

PlayCompleted

Whether the recorded plays ran to their ends rather than being stopped or cut short; null for a recording that never wrote its counts.

public bool? PlayCompleted { get; init; }

Property Value

bool?

PositionCount

The toolpath positions recorded; null for a recording that never wrote its counts.

public int? PositionCount { get; init; }

Property Value

int?

StepCount

The steps recorded; null for a recording that never wrote its counts.

public int? StepCount { get; init; }

Property Value

int?