Header menu logo issie

SheetInterface Module

Type extensions

Type extension Description

this.ChangeAdderComp

Full Usage: this.ChangeAdderComp

Parameters:

Extended Type: Model

dispatch : Dispatch<Msg>
compId : ComponentId
newComp : ComponentType

this.ChangeComponent

Full Usage: this.ChangeComponent

Parameters:

Extended Type: Model

dispatch : Dispatch<Msg>
symModel : Model
compId : ComponentId
compType : ComponentType

this.ChangeCounterComp

Full Usage: this.ChangeCounterComp

Parameters:

Extended Type: Model

dispatch : Dispatch<Msg>
compId : ComponentId
newComp : ComponentType

this.ChangeGate

Full Usage: this.ChangeGate

Parameters:

Given a compId and the number in inputs, set the number of inputs for a gate

Extended Type: Model

dispatch : Dispatch<Msg>
compId : ComponentId
gateType : GateComponentType
n : int

this.ChangeInputValue

Full Usage: this.ChangeInputValue

Parameters:

Extended Type: Model

dispatch : Dispatch<Msg>
compId : ComponentId
newVal : bigint

this.ChangeLSB

Full Usage: this.ChangeLSB

Parameters:

Given a compId and a LSB, update the LSB of the Component specified by compId

Extended Type: Model

dispatch : Dispatch<Msg>
compId : ComponentId
lsb : bigint

this.ChangeLabel

Full Usage: this.ChangeLabel

Parameters:

Change the label of Component specified by compId to lbl

Extended Type: Model

dispatch : Dispatch<Msg>
compId : ComponentId
lbl : string

this.ChangeMergeN

Full Usage: this.ChangeMergeN

Parameters:

Given a compId, number of inputs

Extended Type: Model

dispatch : Dispatch<Msg>
compId : ComponentId
numInputs : int

this.ChangeReversedInputs

Full Usage: this.ChangeReversedInputs

Parameters:

Given a compId, update the ReversedInputs property of the Component specified by compId

Extended Type: Model

dispatch : Dispatch<Msg>
compId : ComponentId

this.ChangeScale

Full Usage: this.ChangeScale

Parameters:

Given a compId and a width, update the width of the Component specified by compId

Extended Type: Model

dispatch : Dispatch<Msg>
compId : ComponentId
newScale : float
whichScale : ScaleAdjustment

this.ChangeSplitN

Full Usage: this.ChangeSplitN

Parameters:
    dispatch : Dispatch<Msg>
    compId : ComponentId
    numInputs : int
    widths : int list
    lsbs : int list

Given comId, number of inputs, widths and LSBs

Extended Type: Model

dispatch : Dispatch<Msg>
compId : ComponentId
numInputs : int
widths : int list
lsbs : int list

this.ChangeWidth

Full Usage: this.ChangeWidth

Parameters:

Given a compId and a width, update the width of the Component specified by compId

Extended Type: Model

dispatch : Dispatch<Msg>
compId : ComponentId
width : int

this.ClearCanvas

Full Usage: this.ClearCanvas

Parameters:
    dispatch : Msg -> unit

Clears the canvas, removes all components and connections

Extended Type: Model

dispatch : Msg -> unit

this.DoBusWidthInference

Full Usage: this.DoBusWidthInference

Parameters:
    dispatch : Msg -> 'a

Returns: 'a

Run Bus Width Inference check

Extended Type: Model

dispatch : Msg -> 'a
Returns: 'a

this.FlushCommandStack

Full Usage: this.FlushCommandStack

Parameters:
    dispatch : Msg -> 'a

Returns: 'a

Clears the Undo and Redo stack of Sheet

Extended Type: Model

dispatch : Msg -> 'a
Returns: 'a

this.GenerateLabel

Full Usage: this.GenerateLabel

Parameters:
Returns: string

Given a compType, return a label

Extended Type: Model

compType : ComponentType
Returns: string

this.GetCanvasState

Full Usage: this.GetCanvasState

Parameters:
    () : unit

Returns: Component list * Connection list

Get the current canvas state in the form of (Component list * Connection list)

Extended Type: Model

() : unit
Returns: Component list * Connection list

this.GetComponentById

Full Usage: this.GetComponentById

Parameters:
Returns: Component

Given a compId, return the corresponding component

Extended Type: Model

compId : ComponentId
Returns: Component

this.GetNotifications

Full Usage: this.GetNotifications

Parameters:
    () : unit

Returns: Option<string>

Return Some string if Sheet / BusWire / Symbol has a notification, if there is none then return None

Extended Type: Model

() : unit
Returns: Option<string>

this.GetNotifications

Full Usage: this.GetNotifications

Returns: Option<string>

Return Some string if Sheet / BusWire / Symbol has a notification, if there is none then return None

Extended Type: Model

Returns: Option<string>

this.GetSelectedCanvasState

Full Usage: this.GetSelectedCanvasState

Parameters:
    () : unit

Returns: Component list * Connection list

Returns a list of selected components and connections in the form of (Component list * Connection list)

Extended Type: Model

() : unit
Returns: Component list * Connection list

this.GetSelectedCanvasState

Full Usage: this.GetSelectedCanvasState

Returns: Component list * Connection list

Returns a list of selected components and connections in the form of (Component list * Connection list)

Extended Type: Model

Returns: Component list * Connection list

this.GetSelectedComponents

Full Usage: this.GetSelectedComponents

Parameters:
    () : unit

Returns: Component list

Returns a list of selected components

Extended Type: Model

() : unit
Returns: Component list

this.GetSelectedComponents

Full Usage: this.GetSelectedComponents

Returns: Component list

Returns a list of selected components

Extended Type: Model

Returns: Component list

this.GetSelectedConnections

Full Usage: this.GetSelectedConnections

Parameters:
    () : unit

Returns: Connection list

Returns a list of selected connections

Extended Type: Model

() : unit
Returns: Connection list

this.GetSelectedConnections

Full Usage: this.GetSelectedConnections

Returns: Connection list

Returns a list of selected connections

Extended Type: Model

Returns: Connection list

this.SelectConnections

Full Usage: this.SelectConnections

Parameters:
Returns: 'a

Given a list of connIds, select those connections

Extended Type: Model

dispatch : Msg -> 'a
on : bool
connIds : ConnectionId list
Returns: 'a

this.UpdateMemory

Full Usage: this.UpdateMemory

Parameters:
Returns: 'a

Update the memory of component

Extended Type: Model

dispatch : Msg -> 'a
compId : ComponentId
mem : Memory1 -> Memory1
Returns: 'a

this.WriteMemoryLine

Full Usage: this.WriteMemoryLine

Parameters:
    dispatch : Msg -> 'a
    connId : ComponentId
    addr : bigint
    value : bigint

Returns: 'a

Update the memory of component specified by connId at location addr with data value

Extended Type: Model

dispatch : Msg -> 'a
connId : ComponentId
addr : bigint
value : bigint
Returns: 'a

this.WriteMemoryType

Full Usage: this.WriteMemoryType

Parameters:
Returns: 'a

Update the memory of component

Extended Type: Model

dispatch : Msg -> 'a
compId : ComponentId
mem : ComponentType
Returns: 'a

Type something to start searching.