Header menu logo issie

DeveloperModeHelpers Module

Nested modules

Modules Description

Constants

SegmentHelpers

Helpers to work with visual segments and nets Includes functions to remove overlapping same-net segments We can assume different-net segments never overlap.

Functions and values

Function or value Description

calcVisWireLength model

Full Usage: calcVisWireLength model

Parameters:
Returns: float

Sum the wiring length of all wires in the sheet, only counting once when N wire segments of the same-net are overlapping. Returns the total visible wiring segment length over the whole sheet. ASSUMPTION: as in SegmentHelpers

model : Model
Returns: float

createTableFromASegments segments

Full Usage: createTableFromASegments segments

Parameters:
Returns: ReactElement

Function to programmatically generate a html table from a list of wire segments

segments : ASegment list
Returns: ReactElement

createTableFromPortMapsOrder map

Full Usage: createTableFromPortMapsOrder map

Parameters:
Returns: ReactElement

Function to programmatically generate a html table from PortMaps.Order

map : Map<Edge, string list>
Returns: ReactElement

createTableFromPorts portsMap symbol

Full Usage: createTableFromPorts portsMap symbol

Parameters:
Returns: ReactElement

Function to programmatically generate a html table from a Map PortMaps.Oritentation

portsMap : Map<string, Edge>
symbol : Symbol
Returns: ReactElement

findHoveredID pos model

Full Usage: findHoveredID pos model

Parameters:
Returns: string * string

function that returns the an string ID with extra formatting of a hovered wire, symbol, or ports

pos : XYPos
model : Model
Returns: string * string

findRetracingSegments model

Full Usage: findRetracingSegments model

Parameters:
Returns: (type)

Returns the retracing segments, and those which intersect symbols. a segment seg is retracing if the segment before it is zero-length and the segment two segments before has opposite sign length

model : Model
Returns: (type)

getComponentTypeDescrFromSym symbol

Full Usage: getComponentTypeDescrFromSym symbol

Parameters:
Returns: string
symbol : Symbol
Returns: string

numOfIntersectSegSym model

Full Usage: numOfIntersectSegSym model

Parameters:
Returns: int

The Number of distinct wire visible segments that intersect with one or more symbols in the sheet. Counts each such segment even if they overlap (which is not likely) assumes that within one wire, at most one segment crosses a symbol boundary although this is not always true, it is fine for a metric.

model : Model
Returns: int

numOfIntersectedSymPairs sheet

Full Usage: numOfIntersectedSymPairs sheet

Parameters:
Returns: int

Counts the number of pairs of symbols that intersect each other in the sheet. uses sheet Model bounding boxes.

sheet : Model
Returns: int

numOfVisRightAngles model

Full Usage: numOfVisRightAngles model

Parameters:
Returns: int

Counts the visible wire right-angles (bends) over the entire sheet. Where same-net wires overlap a bend is counted only once Returns the number of visible wire right-angles. ASSUMPTIONS: right-angles come from two adjacent visible segments ASSUMPTION: segment overlaps as SegmentHelpers

model : Model
Returns: int

numOfWireRightAngleCrossings model

Full Usage: numOfWireRightAngleCrossings model

Parameters:
Returns: int

The number of pairs of distinct visible wire segments that cross each other at right angles in a sheet. Returns the number right angle intersections between wire segments. Does not include crossings that are "T junction" counts segments that overlap only once ASSUMPTION: overlapping segments are in same Net and have same starting point.

model : Model
Returns: int

overlapArea2DBox bb1 bb2

Full Usage: overlapArea2DBox bb1 bb2

Parameters:
Returns: BoundingBox option

overlap2DBoxvariant from BlockHelpers. Returns a bounding box of an overlap area between two bounding boxes

bb1 : BoundingBox
bb2 : BoundingBox
Returns: BoundingBox option

Type something to start searching.