Type to specify the origin of a custom component

F# data describing the contents of a single schematic sheet.

JSComponent mapped to F# record. Id uniquely identifies the component within a sheet. Label is optional descriptor displayed on schematic.

SHA hash unique to a component - common between JS and F#

Human-readable name of component as displayed on sheet. For I/O/labelIO components a width indication eg (7:0) is also displayed, but NOT included here

JSConnection mapped to F# record. Id uniquely identifies connection globally and is used by library.

SHA hash unique to a connection - common between JS and F#

Value set to None if the connection width could not be inferred.

Keeps track of what cursor to show

Name identifies the LoadedComponent used. The labels define legends on symbol designating inputs or outputs: and are the names of the Input or Output components of the CC sheet. Label strings are unique per CustomComponent. Label position in list determines inputPortNumber or outputPortNumber of label. Multiple CustomComponent instances are differentiated by Component data.

Holds possible directions to sort ports. HLP23: AUTHOR dgs119

Represents the sides of a component

Unique identifier for a fast component. The list is the access path, a list of all the containing custom components from the top sheet of the simulation (root first)

Colors to highlight components Case name is used as HTML color name. See JSHelpers.getColorString lots of colors can be added, see https://www.w3schools.com/colors/colors_names.asp The Text() method converts it to the correct HTML string Where speed matters the color must be added as a case in the match statement

SHA hash unique to a component port - common between JS and F#. Connection ports and connected component ports have the same port Id InputPortId and OutputPortID wrap the hash to distinguish component inputs and outputs some times (e.g. in simulation)

Port numbers are sequential unique with port lists. Inputs and Outputs are both numberd from 0 up.

Messages sent from draw block

Type capturing global key press information TODO: use this consistently, with global key listener, throughout Issie.

Static data describing a schematic sheet loaded as a custom component. Every sheet is always identified with a file from which it is loaded/saved. Name is human readable (and is the filename - without extension) and identifies sheet. File path is the sheet directory and name (with extension). InputLabels, OutputLabels are the I/O connections. The I/O connection integers are bus widths. The I/O connection strings are human readable. The strings are guaranteed to be unique in the I/O connection list. I.e. An input label may be the same as an output label, but two input (or output) labels cannot be the same. The position in the I/O connections list is important as it implicitly indicates the port number. For example, the first element in the InputLabels list is related to the Component's Port with PortNumber 0. Two instances of a loaded component have the same LoadedComponent data.

Note that any memory addresses which have not been explicitly set when printing out memory data.

 Option of this qualifies NBitsXOr to allow many different components
 None => Xor
 TODO to reduce technical debt: 
     Rename NbitsXor as NBitsCustom, put all the Nbits ops into this D.U.
     Change catalog entries for all NBits ops to use NBitsCustom, alter load to remain compatibility.

SHA hash unique to a component port - common between JS and F#. Connection ports and connected component ports have the same port Id InputPortId and OutputPortID wrap the hash to distinguish component inputs and outputs some times (e.g. in simulation)

Port numbers are sequential unique with port lists. Inputs and Outputs are both numberd from 0 up.

A component I/O. Id (like any other Id) is a string generated with 32 random hex charactes, so it is (practically) globally unique. These Ids are used to uniquely refer to ports and components. They are generated via uuid(). PortNumber is used to identify which port is which on a component, contiguous from 0 separately for inputs and outputs. See comments above type definition for details HostId is the unique Id of the component where the port is. For example, all three ports on the same And component will have the same HostId.

Specify the type of a port in a Component.

Type for an open project which represents a complete design. ProjectPath is directory containing project files. OpenFileName is name of file from which current schematic sheet is loaded/saved, without extension or path LoadedComponents contains the list of schematic sheets, each as a component, one per sheet.

reduced version of CanvasState for electrical comparison, all geometry removed, components ordered

Represents the rotation of a symbol in degrees, Degree0 is the default symbol rotation. Angle is anticlockwise

Stores the rotation and the flip of the symbol, flipped false by default

Info saved by Wave Sim. This info is not necessarilu uptodate with deletions or additions in the Diagram. The wavesim code processing this will not fail if non-existent nets are referenced.

type to uniquely identify a segment

Info regarding sheet saved in the .dgm file

Uniquely identifies a wave by the component it comes from, and the port on which that wave is from. Two waves can be identical but have a different index (e.g. a wave with PortType Input must be driven by another wave of PortType Output).

This width is for wire displaying, >8 buswires displayed with 8px thickness. Actual size stored in Port type

Documents user circuit error found during connection width inference

unconfigured replaces Some -1, Error replaces None, Configured of int replaces Some (positive int)

Position on SVG canvas Positions can be added, subtracted, scaled using overloaded +,-, * operators currently these custom operators are not used in Issie - they should be!