SidecarSessionState (issie)

SidecarSessionState Type

Namespace: global
Assembly: Renderer.dll
Parent Module: ModelType
Base Type: obj
All Interfaces: IEquatable<SidecarSessionState> , IStructuralEquatable , IComparable<SidecarSessionState> , IComparable , IStructuralComparable

The session the sidecar holds, which is what an operation commands. Not an operation in flight and so not in the table above: a build that has finished leaves a session behind, and it is the session that the next run or read names. Whether a build is RUNNING is read off the table (`ModelHelpers.sidecarIsBuilding`), so there is one place that says so rather than a state here that could disagree with it.

Union cases

Union case	Description
`NoSession` Full Usage: `NoSession`	nothing built: none has been asked for, or the last simulation ended
`Session(top, arraySize, epoch, clock)` Full Usage: `Session(top, arraySize, epoch, clock)` Parameters: top : `string` arraySize : `int` epoch : `int` clock : `int`	the sidecar holds this design, at this array size, under this session epoch, and has been run as far as this clock. The clock is here because a run is a sequence of operations and what each one reports is how far it got - so the progress of a run is model state, drawn like anything else, rather than a callback threaded down to a caller that ignored it top : `string` arraySize : `int` epoch : `int` clock : `int`
`SessionFailed string` Full Usage: `SessionFailed string` Parameters: Item : `string`	the last build failed, saying this. Kept so the UI can show it rather than retry for ever Item : `string`

Instance members

Instance member	Description
`this.Clock` Full Usage: `this.Clock` Returns: `int`	Whether the sidecar already holds what a caller is about to ask for. An array size bigger than the one built for needs a new build; a smaller one does not, since the arrays it wants are inside the ones there are. How far the session has been run, or 0 when there is not one. Returns: `int`
`this.Epoch` Full Usage: `this.Epoch` Returns: `int option`	The session to command, when there is one. Returns: `int option`
`this.Holds` Full Usage: `this.Holds` Parameters: top : `string` arraySize : `int` Returns: `bool`	top : `string` arraySize : `int` Returns: `bool`
`this.IsNoSession` Full Usage: `this.IsNoSession` Returns: `bool`	Returns: `bool`
`this.IsSession` Full Usage: `this.IsSession` Returns: `bool`	Returns: `bool`
`this.IsSessionFailed` Full Usage: `this.IsSessionFailed` Returns: `bool`	Returns: `bool`