Class NcResultCompletion
- Namespace
- Hi.MachiningProcs
- Assembly
- HiNc.dll
Internal Use Only. What Complete(bool, Action<string>) answers: the outcome, where the file is, what it holds and the range of steps it holds.
public sealed record NcResultCompletion : IEquatable<NcResultCompletion>
- Inheritance
-
NcResultCompletion
- Implements
- Inherited Members
- Extension Methods
Constructors
NcResultCompletion(NcResultCompletionOutcome, string, string, bool, NcResultRecorderCounts, int, int)
Internal Use Only. What Complete(bool, Action<string>) answers: the outcome, where the file is, what it holds and the range of steps it holds.
public NcResultCompletion(NcResultCompletionOutcome Outcome, string ResultDirectory, string DatabasePath, bool PlayCompleted, NcResultRecorderCounts Counts, int FirstStepIndex, int LastStepIndex)
Parameters
OutcomeNcResultCompletionOutcomeHow the completion ended.
ResultDirectorystringThe result folder's full path; null when nothing was recorded.
DatabasePathstringThe full path of the
result.db; null when nothing was recorded.PlayCompletedboolWhat the file's
Metasays about the play: whether it ran to its end.CountsNcResultRecorderCountsThe records taken, refused, dropped.
FirstStepIndexintThe lowest step index the file took; -1 without a step.
LastStepIndexintThe highest step index the file took; -1 without a step.
Properties
Counts
The records taken, refused, dropped.
public NcResultRecorderCounts Counts { get; init; }
Property Value
DatabasePath
The full path of the result.db; null when nothing was recorded.
public string DatabasePath { get; init; }
Property Value
FirstStepIndex
The lowest step index the file took; -1 without a step.
public int FirstStepIndex { get; init; }
Property Value
IsFinalized
Whether the file is completed (Completed or CompletedWithoutWct): one self-contained file a review opens.
public bool IsFinalized { get; }
Property Value
LastStepIndex
The highest step index the file took; -1 without a step.
public int LastStepIndex { get; init; }
Property Value
Outcome
How the completion ended.
public NcResultCompletionOutcome Outcome { get; init; }
Property Value
PlayCompleted
What the file's Meta says about the play: whether it ran to its end.
public bool PlayCompleted { get; init; }
Property Value
ResultDirectory
The result folder's full path; null when nothing was recorded.
public string ResultDirectory { get; init; }