jitx¶

Package name: jitx

Summary¶

Data Types¶

JITXDef ¶

Multis¶

Function	Description
id

Stackup ¶

Constructors¶

Function	Description
Stackup	Constructor for `defstruct Stackup`

LandPattern ¶

Constructors¶

Function	Description
LandPattern	Constructor for `defstruct LandPattern`

DifferentialRoutingStructure ¶

Constructors¶

Function	Description
DifferentialRoutingStructure	Constructor for `defstruct DifferentialRoutingStructure`

ViewMode ¶

SinglePin ¶

Constructors¶

Function	Description
SinglePin	Constructor for `defstruct SinglePin`

StackupLayer ¶

Constructors¶

Function	Description
StackupLayer	Constructor for `defstruct StackupLayer`

InstanceType ¶

BOMColumn ¶

Constructors¶

Function	Description
BOMColumn	Constructor for `defstruct BOMColumn`

JITXObjectProperty ¶

Constructors¶

Function	Description
JITXObjectProperty	Constructor for `defstruct JITXObjectProperty`

MaterialType ¶

Both ¶

A supplement to the Side enum representing both sides of the board.

Functions¶

Function	Description
to-tented

JITXObject ¶

Multis¶

Function	Description
local
unsafe-hash

Functions¶

Function	Description
local-kv-to-pins
local-kv?
kv?-local
local?
local-kv

Instantiable ¶

Constructors¶

Function	Description
Instantiable	Constructor for `defstruct Instantiable`

Bundle ¶

Constructors¶

Function	Description
Bundle	Constructor for `defstruct Bundle`

ViaStructure ¶

Constructors¶

Function	Description
ViaStructure	Constructor for `defstruct ViaStructure`

SchematicSymbol ¶

Constructors¶

Function	Description
SchematicSymbol	Constructor for `defstruct SchematicSymbol`

BOMViewMode ¶

Backdrill ¶

Constructors¶

Function	Description
Backdrill	Constructor for `defstruct Backdrill`

Instance ¶

Constructors¶

Function	Description
Instance	Constructor for `defstruct Instance`

PortArray ¶

Constructors¶

Function	Description
PortArray	Constructor for `defstruct PortArray`

BOMField ¶

Model3D ¶

Constructors¶

Function	Description
Model3D	Constructor for `defstruct Model3D`

TopologyName ¶

Constructors¶

Function	Description
TopologyName	Constructor for `defstruct TopologyName`

SymbolPin ¶

Constructors¶

Function	Description
SymbolPin	Constructor for `defstruct SymbolPin`

ImportCadResult ¶

ImportResult ¶

Constructors¶

Function	Description
ImportResult	Constructor for `defstruct ImportResult`

Board ¶

Constructors¶

Function	Description
Board	Constructor for `defstruct Board`

Material ¶

Constructors¶

Function	Description
Material	Constructor for `defstruct Material`

ViaType ¶

Functions¶

Function	Description
esir-via-type

IpcInfo ¶

Constructors¶

Function	Description
IpcInfo	Constructor for `defstruct IpcInfo`

BOMMetricType ¶

PadType ¶

LandPatternPad ¶

Constructors¶

Function	Description
LandPatternPad	Constructor for `defstruct LandPatternPad`

ClearanceType ¶

PackagePose ¶

Constructors¶

Function	Description
PackagePose	Constructor for `defstruct PackagePose`

InstantiableArray ¶

Constructors¶

Function	Description
InstantiableArray	Constructor for `defstruct InstantiableArray`

Rules ¶

Constructors¶

Function	Description
Rules	Constructor for `defstruct Rules`

ConnectedItems ¶

Constructors¶

Function	Description
ConnectedItems	Constructor for `defstruct ConnectedItems`

ComponentBoardStatus ¶

TransmissionType ¶

RuleClearance ¶

Constructors¶

Function	Description
RuleClearance	Constructor for `defstruct RuleClearance`

Vec3D ¶

Constructors¶

Function	Description
Vec3D	Constructor for `defstruct Vec3D`

ViaDrillType ¶

Self ¶

Constructors¶

Function	Description
Self	Constructor for `defstruct Self`

CadSoftware ¶

RoutingStructure ¶

Constructors¶

Function	Description
RoutingStructure	Constructor for `defstruct RoutingStructure`

Via ¶

Constructors¶

Function	Description
Via	Constructor for `defstruct Via`

BOMMetric ¶

Constructors¶

Function	Description
BOMMetric	Constructor for `defstruct BOMMetric`

RoutingRules ¶

Constructors¶

Function	Description
RoutingRules	Constructor for `defstruct RoutingRules`

Pad ¶

Constructors¶

Function	Description
Pad	Constructor for `defstruct Pad`

ComponentBOMStatus ¶

Pin ¶

Constructors¶

Function	Description
Pin	Constructor for `defstruct Pin`

PortType ¶

Functions¶

Function	Description
get (+ 2)

NetClass ¶

Constructors¶

Function	Description
NetClass	Constructor for `defstruct NetClass`

Functions¶

Function	Description
NetClass

InstantiableType ¶

Functions¶

Function	Description
get

Net ¶

Constructors¶

Function	Description
Net	Constructor for `defstruct Net`

TraceType ¶

General Definitions¶

Function	Description
symmetric-about-x (+ 1)
symmetric-about-y (+ 1)
vector (+ 1)
mirror-x-loc
mirror-y-loc
via-type-name
deprecate-syntax (+ 1)

Variable	Description
Both	The one value of this type.
self

Definitions¶

JITXDef¶

public deftype JITXDef <: Hashable & Equalable

Multis¶

id¶

public defmulti id (def:JITXDef) -> DefID

Returns DefID

Stackup¶

public defstruct Stackup <: JITXDef

Constructors¶

Stackup¶

Constructor for defstruct Stackup

public defn Stackup (id:DefID)

LandPattern¶

public defstruct LandPattern <: JITXDef

Constructors¶

LandPattern¶

Constructor for defstruct LandPattern

public defn LandPattern (id:DefID)

DifferentialRoutingStructure¶

public defstruct DifferentialRoutingStructure <: JITXDef

Constructors¶

DifferentialRoutingStructure¶

Constructor for defstruct DifferentialRoutingStructure

public defn DifferentialRoutingStructure (id:DefID)

ViewMode¶

public defenum ViewMode <: Equalable & Hashable

UpdateView
NewView

SinglePin¶

public defstruct SinglePin <: PortType

Constructors¶

SinglePin¶

Constructor for defstruct SinglePin

public defn SinglePin ()

StackupLayer¶

public defstruct StackupLayer <: JITXObject

Constructors¶

StackupLayer¶

Constructor for defstruct StackupLayer

public defn StackupLayer (local:Local)

InstanceType¶

public defenum InstanceType <: Equalable & Hashable

SingleComponent
SingleModule
InstanceArray

BOMColumn¶

public defstruct BOMColumn
    field: BOMField
    name: String
    width: Double

field: BOMField
name: String
width: Double

Constructors¶

BOMColumn¶

Constructor for defstruct BOMColumn

public defn BOMColumn (field:BOMField, name:String, width:Double)

JITXObjectProperty¶

public defstruct JITXObjectProperty
    object: JITXObject
    property-name: Symbol
    value: ?

object: JITXObject
property-name: Symbol
value: ?

Constructors¶

JITXObjectProperty¶

Constructor for defstruct JITXObjectProperty

public defn JITXObjectProperty (object:JITXObject, property-name:Symbol, value:?)

MaterialType¶

public defenum MaterialType <: Equalable & Hashable

Conductor
Dielectric

Both¶

A supplement to the Side enum representing both sides of the board.

public deftype Both

Functions¶

to-tented¶

public defn to-tented (v:Side|Both|True|False) -> Side|True|False

Returns Side|True|False

JITXObject¶

public deftype JITXObject <: Equalable

Multis¶

local¶

public defmulti local (obj:JITXObject) -> Local

Returns Local

unsafe-hash¶

public defmulti unsafe-hash (obj:JITXObject) -> Int

Returns Int

Functions¶

local-kv-to-pins¶

public defn local-kv-to-pins (obj:KeyValue<Local, Local>) -> KeyValue<JITXObject, JITXObject>

Returns KeyValue<JITXObject, JITXObject>

local-kv?¶

public defn local-kv? (obj:KeyValue<JITXObject, JITXObject>|JITXObject|False) -> KeyValue<Local, Local>|Local|False

Returns KeyValue<Local, Local>|Local|False

kv?-local¶

public defn kv?-local (obj:KeyValue<JITXObject, JITXObject>|JITXObject) -> KeyValue<Local, Local>|Local

Returns KeyValue<Local, Local>|Local

local?¶

public defn local? (obj:JITXObject|False) -> Local|False

Returns Local|False

local-kv¶

public defn local-kv (obj:KeyValue<JITXObject, JITXObject>) -> KeyValue<Local, Local>

Returns KeyValue<Local, Local>

Instantiable¶

public defstruct Instantiable <: JITXDef & InstantiableType

Constructors¶

Instantiable¶

Constructor for defstruct Instantiable

public defn Instantiable (id:DefID)

Bundle¶

public defstruct Bundle <: JITXDef & PortType

Constructors¶

Bundle¶

Constructor for defstruct Bundle

public defn Bundle (id:DefID)

ViaStructure¶

public defstruct ViaStructure <: JITXObject

Constructors¶

ViaStructure¶

Constructor for defstruct ViaStructure

public defn ViaStructure (local:Local)

SchematicSymbol¶

public defstruct SchematicSymbol <: JITXDef

Constructors¶

SchematicSymbol¶

Constructor for defstruct SchematicSymbol

public defn SchematicSymbol (id:DefID)

BOMViewMode¶

public defenum BOMViewMode <: Equalable & Hashable

BOM-STD
BOM-DIFF
BOM-LAST

Backdrill¶

public defstruct Backdrill <: Equalable & Hashable
    copper-clearance: Double
    diameter: Double
    side: Side
    solder-mask-opening: Double
    startpad-diameter: Double
    stop: LayerIndex

copper-clearance: Double
diameter: Double
side: Side
solder-mask-opening: Double
startpad-diameter: Double
stop: LayerIndex

Constructors¶

Backdrill¶

Constructor for defstruct Backdrill

public defn Backdrill (side:Side, stop:LayerIndex, diameter:Double, startpad-diameter:Double, solder-mask-opening:Double, copper-clearance:Double)

Instance¶

public defstruct Instance <: JITXObject

Constructors¶

Instance¶

Constructor for defstruct Instance

public defn Instance (local:Local)

PortArray¶

public defstruct PortArray <: PortType
    base: PortType
    elements: Tuple<Int>

base: PortType
elements: Tuple<Int>

Constructors¶

PortArray¶

Constructor for defstruct PortArray

public defn PortArray (type:PortType, elements:Tuple<Int|Range>)

BOMField¶

public defenum BOMField <: Equalable & Hashable

BOMFieldStatus
BOMFieldDescription
BOMFieldInsts
BOMFieldDatasheet
BOMFieldManufacturer
BOMFieldMPN
BOMFieldVendor
BOMFieldSKU
BOMFieldQuantity
BOMFieldPrice
BOMFieldSubtotal
BOMFieldPreferred

Model3D¶

public defstruct Model3D <: Hashable & Equalable
    filename: String
    position: Vec3D
    properties: Tuple<KeyValue<String, String>>
    rotation: Vec3D
    scale: Vec3D

filename: String
position: Vec3D
properties: Tuple<KeyValue<String, String>>
rotation: Vec3D
scale: Vec3D

Constructors¶

Model3D¶

Constructor for defstruct Model3D

public defn Model3D (filename:String, position:Vec3D, scale:Vec3D, rotation:Vec3D, properties:Tuple<KeyValue<String, String>> = ?)

TopologyName¶

public defstruct TopologyName <: JITXObject

Constructors¶

TopologyName¶

Constructor for defstruct TopologyName

public defn TopologyName (local:Local)

SymbolPin¶

public defstruct SymbolPin <: JITXObject

Constructors¶

SymbolPin¶

Constructor for defstruct SymbolPin

public defn SymbolPin (local:Local)

ImportCadResult¶

public deftype ImportCadResult

ImportResult¶

public defstruct ImportResult <: ImportCadResult
    directory: String

directory: String

Constructors¶

ImportResult¶

Constructor for defstruct ImportResult

public defn ImportResult (directory:String)

Board¶

public defstruct Board <: JITXDef

Constructors¶

Board¶

Constructor for defstruct Board

public defn Board (id:DefID)

Material¶

public defstruct Material <: JITXDef

Constructors¶

Material¶

Constructor for defstruct Material

public defn Material (id:DefID)

ViaType¶

public defenum ViaType <: Equalable & Hashable

THVia
MicroVia
BlindVia

Functions¶

esir-via-type¶

public defn esir-via-type (via-type-name:String) -> ViaType

Returns ViaType

IpcInfo¶

public defstruct IpcInfo
    name: String

name: String

Constructors¶

IpcInfo¶

Constructor for defstruct IpcInfo

public defn IpcInfo (name:String)

BOMMetricType¶

public defenum BOMMetricType <: Equalable & Hashable

BOMMetricLineItems
BOMMetricComponentCount
BOMMetricTotalCost

PadType¶

public defenum PadType <: Equalable & Hashable

SMD
TH

LandPatternPad¶

public defstruct LandPatternPad <: JITXObject

Constructors¶

LandPatternPad¶

Constructor for defstruct LandPatternPad

public defn LandPatternPad (local:Local)

ClearanceType¶

public defenum ClearanceType <: Equalable & Hashable

MinCopperWidth
MinCopperCopperSpace
MinCopperHoleSpace
MinCopperEdgeSpace
MinAnnularRing
MinDrillDiameter
MinSilkscreenWidth
MinPitchLeaded
MinPitchBGA
MaxBoardWidth
MaxBoardHeight
SolderMaskRegistration
MinSilkscreenTextHeight
MinSilkSolderMaskSpace
MinThPadExpandOuter
MinSolderMaskOpening
MinSolderMaskBridge
MinHoleToHole
MinPthPinSolderClearance

PackagePose¶

public defstruct PackagePose
    anchor: Instance|False
    inst: Instance
    pose: Pose|False
    side: Side

anchor: Instance|False
inst: Instance
pose: Pose|False
side: Side

Constructors¶

PackagePose¶

Constructor for defstruct PackagePose

public defn PackagePose (inst:Instance, pose:Pose|False, side:Side, anchor:Instance|False)

InstantiableArray¶

public defstruct InstantiableArray <: InstantiableType
    base: InstantiableType
    length: Int

base: InstantiableType
length: Int

Constructors¶

InstantiableArray¶

Constructor for defstruct InstantiableArray

public defn InstantiableArray (base:InstantiableType, length:Int)

Rules¶

public defstruct Rules <: JITXDef

Constructors¶

Rules¶

Constructor for defstruct Rules

public defn Rules (id:DefID)

ConnectedItems¶

public defstruct ConnectedItems
    abstract-pins: Tuple<Pin>
    component-pins: Tuple<Pin>
    module-pins: Tuple<Pin>
    nets: Tuple<Net>

abstract-pins: Tuple<Pin>
component-pins: Tuple<Pin>
module-pins: Tuple<Pin>
nets: Tuple<Net>

Constructors¶

ConnectedItems¶

Constructor for defstruct ConnectedItems

public defn ConnectedItems (nets:Tuple<Net>, module-pins:Tuple<Pin>, component-pins:Tuple<Pin>, abstract-pins:Tuple<Pin>)

ComponentBoardStatus¶

public defenum ComponentBoardStatus <: Equalable & Hashable

OnBoard
NotOnBoard
InBoardVariant

TransmissionType¶

public defenum TransmissionType <: Equalable & Hashable

StriplineTransmission
DifferentialMicroStripTransmission

RuleClearance¶

public defstruct RuleClearance <: PropertyValue
    type: ClearanceType
    value: Double

type: ClearanceType
value: Double

Constructors¶

RuleClearance¶

Constructor for defstruct RuleClearance

public defn RuleClearance (type:ClearanceType, value:Double)

Vec3D¶

public defstruct Vec3D <: Hashable & Equalable
    x: Double
    y: Double
    z: Double

x: Double
y: Double
z: Double

Constructors¶

Vec3D¶

Constructor for defstruct Vec3D

public defn Vec3D (x:Double, y:Double, z:Double)

ViaDrillType¶

public defenum ViaDrillType <: Equalable & Hashable

MechanicalDrill
LaserDrill

Self¶

public defstruct Self <: JITXObject

Constructors¶

Self¶

Constructor for defstruct Self

public defn Self (local:Local)

CadSoftware¶

public defenum CadSoftware <: Equalable & Hashable

Kicad
KicadV5
KicadV6
Altium
AltiumJSON

RoutingStructure¶

public defstruct RoutingStructure <: JITXDef

Constructors¶

RoutingStructure¶

Constructor for defstruct RoutingStructure

public defn RoutingStructure (id:DefID)

Via¶

public defstruct Via <: JITXDef

Constructors¶

Via¶

Constructor for defstruct Via

public defn Via (id:DefID)

BOMMetric¶

public defstruct BOMMetric
    metric: BOMMetricType
    name: String
    value: Maybe<Int|Double|String>

metric: BOMMetricType
name: String
value: Maybe<Int|Double|String>

Constructors¶

BOMMetric¶

Constructor for defstruct BOMMetric

public defn BOMMetric (metric:BOMMetricType, name:String, value:Maybe<Int|Double|String> = ?)

RoutingRules¶

public defstruct RoutingRules <: JITXObject

Constructors¶

RoutingRules¶

Constructor for defstruct RoutingRules

public defn RoutingRules (local:Local)

Pad¶

public defstruct Pad <: JITXDef

Constructors¶

Pad¶

Constructor for defstruct Pad

public defn Pad (id:DefID)

ComponentBOMStatus¶

public defenum ComponentBOMStatus <: Equalable & Hashable

InBOM
NotInBOM
MarkedDNP
InBOMVariant

Pin¶

public defstruct Pin <: JITXObject

Constructors¶

Pin¶

Constructor for defstruct Pin

public defn Pin (local:Local)

PortType¶

public deftype PortType <: Hashable & Equalable

Functions¶

get¶

public defn get (c:PortType, elems:Tuple<Int|Range>) -> PortType

Returns PortType

get¶

public defn get (c:PortType, elems:Range) -> PortType

Returns PortType

get¶

public defn get (c:PortType, length:Int) -> PortType

Returns PortType

NetClass¶

public defstruct NetClass <: Equalable & Hashable
    min-space: False|Double
    min-trace: False|Double
    min-via-diameter: False|Double
    min-via-drill: False|Double
    name: Symbol

min-space: False|Double
min-trace: False|Double
min-via-diameter: False|Double
min-via-drill: False|Double
name: Symbol

Constructors¶

NetClass¶

Constructor for defstruct NetClass

public defn NetClass (name:Symbol, min-space:False|Double, min-trace:False|Double, min-via-diameter:False|Double, min-via-drill:False|Double)

Functions¶

NetClass¶

public defn NetClass (name:Symbol, specs:Collection<KeyValue<Symbol, Double>>) -> NetClass

Returns NetClass

InstantiableType¶

public deftype InstantiableType <: Equalable

Functions¶

get¶

public defn get (c:InstantiableType, len:Int) -> InstantiableType

Returns InstantiableType

Net¶

public defstruct Net <: JITXObject

Constructors¶

Net¶

Constructor for defstruct Net

public defn Net (local:Local)

TraceType¶

public defenum TraceType <: Equalable & Hashable & PropertyValue

SingleEndedTrace
DifferentialTrace

General Definitions¶

symmetric-about-x¶

public defn symmetric-about-x<?T> (axis:Double, ss:Seqable<Shape&?T>)

symmetric-about-x¶

public defn symmetric-about-x<?T> (ss:Seqable<Shape&?T>)

symmetric-about-y¶

public defn symmetric-about-y<?T> (axis:Double, ss:Seqable<Shape&?T>)

symmetric-about-y¶

public defn symmetric-about-y<?T> (ss:Seqable<Shape&?T>)

vector¶

public defn vector (dir:Dir, len:Double)

vector¶

public defn vector (dir:Dir)

mirror-x-loc¶

public defn mirror-x-loc (axis-x:Double)

mirror-y-loc¶

public defn mirror-y-loc (axis-y:Double)

via-type-name¶

public defn via-type-name (start:LayerIndex, end:LayerIndex, hole-radius:Double, num-copper-layers:Int) -> String

Returns String

deprecate-syntax¶

public defn deprecate-syntax (info:FileInfo|False, keyword:String, new-keyword:String, context:String, v)

deprecate-syntax¶

public defn deprecate-syntax (info:FileInfo|False, keyword:String, context:String, v)

Both¶

The one value of this type.

public val Both

self¶

public val self

Forwards packages: jitx/anchor, jitx/toleranced, jitx/ref, jitx/grid-locs, jitx/layer-specs, jitx/interval, jitx/stateful, jitx/emodel-types, jitx/pose, jitx/transform, jitx/signal-models, jitx/percentage, jitx/shapes