UpdateHelpers (issie)

UpdateHelpers Module

Namespace: global
Assembly: Renderer.dll

Types and nested modules

Type/Module	Description
Constants
RightClickElement

Functions and values

Function or value	Description
`currentSheetIsOutOfDate model` Full Usage: `currentSheetIsOutOfDate model` Parameters: model : `Model` Returns: `bool`	model : `Model` Returns: `bool`
`executePendingMessagesF n model` Full Usage: `executePendingMessagesF n model` Parameters: n : `int` model : `Model` Returns: `Model * Cmd<Msg>`	n : `int` model : `Model` Returns: `Model * Cmd<Msg>`
`exitApp model` Full Usage: `exitApp model` Parameters: model : `Model`	model : `Model`
`filterByOKSheets model sheet` Full Usage: `filterByOKSheets model sheet` Parameters: model : `Model` sheet : `string` Returns: `bool`	model : `Model` sheet : `string` Returns: `bool`
`getContextMenu e model` Full Usage: `getContextMenu e model` Parameters: e : `MouseEvent` model : `Model` Returns: `string`	Function that works out from the right-click event and model what the current context menu should be. output should be a menu name as defined in ContextMenus.contextMenus, or "" for no menu. e : `MouseEvent` model : `Model` Returns: `string`
`getCurrentTimeStamp model` Full Usage: `getCurrentTimeStamp model` Parameters: model : `Model` Returns: `DateTime`	get timestamp of current loaded component. is this ever used? No. model : `Model` Returns: `DateTime`
`getLastMouseMsg msgQueue` Full Usage: `getLastMouseMsg msgQueue` Parameters: msgQueue : `Msg list` Returns: `Msg option`	Returns None if no mouse drag message found, returns Some (lastMouseMsg, msgQueueWithoutMouseMsgs) if a drag message was found msgQueue : `Msg list` Returns: `Msg option`
`getMenuView act model dispatch` Full Usage: `getMenuView act model dispatch` Parameters: act : `MenuCommand` model : `Model` dispatch : `Msg -> Unit` Returns: `Model`	handle Menu actions that may need Model data act : `MenuCommand` model : `Model` dispatch : `Msg -> Unit` Returns: `Model`
`getMessageTraceString msg` Full Usage: `getMessageTraceString msg` Parameters: msg : `Msg` Returns: `string`	If debugTrace is on print out human readable info on message. Be careful not to do this on mouse moves (there are too many). be careful not to try to ptint simulation result arrays (that would crash the renderer!). optimise for very quick return in the case that debugLevel = 0 (production version) optimise for quick return if nothing is printed. msg : `Msg` Returns: `string`
`getSimulationDataOrFail model msg` Full Usage: `getSimulationDataOrFail model msg` Parameters: model : `Model` msg : `string` Returns: `SimulationData`	subfunction used in model update function model : `Model` msg : `string` Returns: `SimulationData`
`isSameMsg` Full Usage: `isSameMsg` Returns: `'a -> 'a -> bool`	Tests physical equality on two objects. Used because Msg type does not support structural equality. DANGER will only work for messages which are physically the the same. In this use case that is fine. Returns: `'a -> 'a -> bool`
`lastMemoryUpdateCheck` Full Usage: `lastMemoryUpdateCheck` Returns: `float`	Returns: `float`
`matchMouseMsg msgSelect msg` Full Usage: `matchMouseMsg msgSelect msg` Parameters: msgSelect : `MouseOp -> bool` msg : `Msg` Returns: `bool`	Used to filter specific mouse messages based on mouse data. msgSelect : `MouseOp -> bool` msg : `Msg` Returns: `bool`
`processContextMenuClick menuType item dispatch model` Full Usage: `processContextMenuClick menuType item dispatch model` Parameters: menuType : `string` item : `string` dispatch : `Msg -> unit` model : `Model` Returns: `Model * Cmd<Msg>`	Function that implement action based on context menu item click. menuType is the menu from chooseContextMenu. item will be one of the possible items in this menu. menuType : `string` item : `string` dispatch : `Msg -> unit` model : `Model` Returns: `Model * Cmd<Msg>`
`processSheetBackAction dispatch model` Full Usage: `processSheetBackAction dispatch model` Parameters: dispatch : `Msg -> unit` model : `Model` Returns: `Model`	Implement action of top bar 'Back' button using the UISheetTrail dispatch : `Msg -> unit` model : `Model` Returns: `Model`
`readUserData userAppDir model` Full Usage: `readUserData userAppDir model` Parameters: userAppDir : `string` model : `Model` Returns: `Model * Cmd<Msg>`	Read persistent user data from file in userAppDir. Store in Model UserData. userAppDir : `string` model : `Model` Returns: `Model * Cmd<Msg>`
`resetDialogIfSelectionHasChanged newModel oldModel` Full Usage: `resetDialogIfSelectionHasChanged newModel oldModel` Parameters: newModel : `Model` oldModel : `Model` Returns: `Model`	Needed so that constant properties selection will work Maybe good idea for other things too? newModel : `Model` oldModel : `Model` Returns: `Model`
`rightClickElement` Full Usage: `rightClickElement` Returns: `RightClickElement`	Returns: `RightClickElement`
`sheetMsg sMsg model` Full Usage: `sheetMsg sMsg model` Parameters: sMsg : `Msg` model : `Model` Returns: `Model * Cmd<Msg>`	sMsg : `Msg` model : `Model` Returns: `Model * Cmd<Msg>`
`shortDSheetMsg sMsg` Full Usage: `shortDSheetMsg sMsg` Parameters: sMsg : `Msg` Returns: `string option`	short summary used where Sheet messages are too complex to print sMsg : `Msg` Returns: `string option`
`shortDWSM ws` Full Usage: `shortDWSM ws` Parameters: ws : `WaveSimModel` Returns: `string option`	short summary of wavesim message which has a lot of data ws : `WaveSimModel` Returns: `string option`
`shortDisplayMsg msg` Full Usage: `shortDisplayMsg msg` Parameters: msg : `Msg` Returns: `string option`	Function returning a short but usually informative display of message used when message tracing (see Sheet menu to which on or off). Parameters that might be very large (like fastsimulation, or Model, or Symbols) should not be displayed using printf "%A". msg : `Msg` Returns: `string option`
`traceMessage startOfUpdateTime msg (arg3, arg4)` Full Usage: `traceMessage startOfUpdateTime msg (arg3, arg4)` Parameters: startOfUpdateTime : `float` msg : `Msg` arg2 : `Model` arg3 : `Cmd<Msg>` Returns: `Model * Cmd<Msg>`	startOfUpdateTime : `float` msg : `Msg` arg2 : `Model` arg3 : `Cmd<Msg>` Returns: `Model * Cmd<Msg>`
`updateAllMemoryCompsIfNeeded model` Full Usage: `updateAllMemoryCompsIfNeeded model` Parameters: model : `Model` Returns: `Model`	model : `Model` Returns: `Model`
`updateComponentMemory addr data compOpt` Full Usage: `updateComponentMemory addr data compOpt` Parameters: addr : `bigint` data : `bigint` compOpt : `Component option` Returns: `Component option`	addr : `bigint` data : `bigint` compOpt : `Component option` Returns: `Component option`
`updateTimeStamp model` Full Usage: `updateTimeStamp model` Parameters: model : `Model` Returns: `Model`	Replace timestamp of current loaded component in model project by current time Used in update function model : `Model` Returns: `Model`
`updateTimeTotal` Full Usage: `updateTimeTotal` Returns: `float`	Returns: `float`
`verilogOutputPage sheet fPath` Full Usage: `verilogOutputPage sheet fPath` Parameters: sheet : `'a` fPath : `string` Returns: `ReactElement`	sheet : `'a` fPath : `string` Returns: `ReactElement`
`withNoMsg model` Full Usage: `withNoMsg model` Parameters: model : `Model` Returns: `Model * Cmd<Msg>`	Adapter function to pipeline adding a default "Cmd.none" command to a model as returned in update function. model : `Model` Returns: `Model * Cmd<Msg>`
`writeUserData model` Full Usage: `writeUserData model` Parameters: model : `Model` Returns: `Model`	model : `Model` Returns: `Model`