jsl/symbols/capacitors¶
Package name: jsl/symbols/capacitors
Summary¶
Data Types¶
CapacitorSymbolParams¶
Construct Parameter Set for a Non-Polarized Capacitor Symbol
Constructors¶
Function | Description |
---|---|
CapacitorSymbolParams (+ 1) | Constructor for defstruct CapacitorSymbolParams |
Functions¶
Function | Description |
---|---|
build-capacitor-glyphs | Construct the Non-Polarized Capacitor Glyph Geometry |
set-default-cap-symbol-params | |
get-default-cap-symbol-params | |
sub-base-params | |
to-tuple |
CapacitorSymbol¶
Non-Polarized Capacitor Symbol
Constructors¶
Function | Description |
---|---|
CapacitorSymbol (+ 1) | Constructor for defstruct CapacitorSymbol |
PolarizedCapacitorSymbolParams¶
Construct Parameter Set for PolCap Symbol Shape
Constructors¶
Function | Description |
---|---|
PolarizedCapacitorSymbolParams (+ 1) | Constructor for defstruct PolarizedCapacitorSymbolParams |
Functions¶
Function | Description |
---|---|
build-pol-cap-glyphs | Build the Polarized Capacitor Glyph Geometry |
set-default-polarized-cap-symbol-params | |
PolarizedCapacitorSymbol | |
sub-base-params | |
get-default-polarized-cap-symbol-params |
PolarizedStyle¶
PolarizedCapacitorSymbol¶
Functions¶
Function | Description |
---|---|
PolarizedCapacitorSymbol |
General Definitions¶
Definitions¶
CapacitorSymbolParams¶
Construct Parameter Set for a Non-Polarized Capacitor Symbol
public defstruct CapacitorSymbolParams <: SymbolParams :
line-width: Double
porch-width: Double|Percentage
width: Double
-
line-width: Double
-
porch-width: Double|Percentage
- The porch width is the length of line from the pin to the capacitor plate lines This value can be either an absolute value in symbol grid units or it can be a percentage of thepitch / 2.0
. -
width: Double
Each keyword argument for this function has a default value that can be overridden. These parameters are all of the configurable aspects of the symbol.
Constructors¶
CapacitorSymbolParams¶
Constructor for defstruct CapacitorSymbolParams
public defn CapacitorSymbolParams (porch-width:Double|Percentage, width:Double = ?, line-width:Double = ?, label-params?:Maybe<SymbolLabelParams> = ?)
CapacitorSymbolParams¶
Constructor for defstruct CapacitorSymbolParams
public defn CapacitorSymbolParams ( -- porch-width:Double|Percentage = ?, width:Double = ?, line-width:Double = ?, label-params?:Maybe<SymbolLabelParams> = ?)
Functions¶
build-capacitor-glyphs¶
Construct the Non-Polarized Capacitor Glyph Geometry
public defn build-capacitor-glyphs (node:SymbolNode, pitch:Double, params:CapacitorSymbolParams)
node: SymbolNode
- Symbol scene graph to draw glyphs in.pitch: Double
- Pin to Pin Distance for two-pin component.params: CapacitorSymbolParams
- Configurable parameters for the generated shape.
set-default-cap-symbol-params¶
public defn set-default-cap-symbol-params (v:CapacitorSymbolParams) -> False
- Returns
False
get-default-cap-symbol-params¶
public defn get-default-cap-symbol-params () -> CapacitorSymbolParams
- Returns
CapacitorSymbolParams
sub-base-params¶
public defn sub-base-params (p:PolarizedCapacitorSymbolParams, b:CapacitorSymbolParams) -> PolarizedCapacitorSymbolParams
- Returns
PolarizedCapacitorSymbolParams
to-tuple¶
public defn to-tuple (p:CapacitorSymbolParams) -> [Double|Percentage, Double, Double]
- Returns
[Double|Percentage, Double, Double]
CapacitorSymbol¶
Non-Polarized Capacitor Symbol
public defstruct CapacitorSymbol <: TwoPinSymbol :
This type is used to generate the two-pin electrical symbol for standard capacitors
Constructors¶
CapacitorSymbol¶
Constructor for defstruct CapacitorSymbol
public defn CapacitorSymbol (pitch:Double, polarized?:True|False = ?, params:Maybe<CapacitorSymbolParams> = ?)
CapacitorSymbol¶
Constructor for defstruct CapacitorSymbol
public defn CapacitorSymbol ( -- pitch:Double = ?, polarized?:True|False = ?, params:Maybe<CapacitorSymbolParams> = ?)
PolarizedCapacitorSymbolParams¶
Construct Parameter Set for PolCap Symbol Shape
public defstruct PolarizedCapacitorSymbolParams <: CapacitorSymbolParams :
plus-size: Double|Percentage
pol-radius: Double
style: PolarizedStyle
-
plus-size: Double|Percentage
-
pol-radius: Double
-
style: PolarizedStyle
The parameters of this function are the configurable features of a Polarized Capacitor's default symbol shape. Each argument has a default value that can be overridden.
Constructors¶
PolarizedCapacitorSymbolParams¶
Constructor for defstruct PolarizedCapacitorSymbolParams
public defn PolarizedCapacitorSymbolParams (style:PolarizedStyle, porch-width:Double|Percentage = ?, width:Double = ?, line-width:Double = ?, pol-radius:Double = ?, plus-size:Double|Percentage = ?, label-params?:Maybe<SymbolLabelParams> = ?)
PolarizedCapacitorSymbolParams¶
Constructor for defstruct PolarizedCapacitorSymbolParams
public defn PolarizedCapacitorSymbolParams ( -- style:PolarizedStyle = ?, porch-width:Double|Percentage = ?, width:Double = ?, line-width:Double = ?, pol-radius:Double = ?, plus-size:Double|Percentage = ?, label-params?:Maybe<SymbolLabelParams> = ?)
Functions¶
build-pol-cap-glyphs¶
Build the Polarized Capacitor Glyph Geometry
public defn build-pol-cap-glyphs (node:SymbolNode, pitch:Double, params:PolarizedCapacitorSymbolParams)
node: SymbolNode
- SymbolNode scenegraph to draw the capacitor inpitch: Double
- Pin to Pin distance for this two-pin componentparams: PolarizedCapacitorSymbolParams
- Configurable parameters of the polarized capacitor symbol shape.
set-default-polarized-cap-symbol-params¶
public defn set-default-polarized-cap-symbol-params (p:PolarizedCapacitorSymbolParams) -> False
- Returns
False
PolarizedCapacitorSymbol¶
public defn PolarizedCapacitorSymbol ( -- pitch:Double = ?, polarized?:True|False = ?, params:PolarizedCapacitorSymbolParams = ?) -> PolarizedCapacitorSymbol
- Returns
PolarizedCapacitorSymbol
sub-base-params¶
public defn sub-base-params (p:PolarizedCapacitorSymbolParams, b:CapacitorSymbolParams) -> PolarizedCapacitorSymbolParams
- Returns
PolarizedCapacitorSymbolParams
get-default-polarized-cap-symbol-params¶
public defn get-default-polarized-cap-symbol-params () -> PolarizedCapacitorSymbolParams
- Returns
PolarizedCapacitorSymbolParams
PolarizedStyle¶
public defenum PolarizedStyle <: Equalable & Hashable
-
Polarized-Straight-Style
-
Polarized-Curved-Style
PolarizedCapacitorSymbol¶
public defstruct PolarizedCapacitorSymbol <: TwoPinSymbol :
Functions¶
PolarizedCapacitorSymbol¶
public defn PolarizedCapacitorSymbol ( -- pitch:Double = ?, polarized?:True|False = ?, params:PolarizedCapacitorSymbolParams = ?) -> PolarizedCapacitorSymbol
- Returns
PolarizedCapacitorSymbol
General Definitions¶
set-default-polarized-capacitor-symbol¶
public defn set-default-polarized-capacitor-symbol (symb:TwoPinSymbol)
set-default-capacitor-symbol¶
public defn set-default-capacitor-symbol (symb:TwoPinSymbol)
get-default-polarized-capacitor-symbol¶
public defn get-default-polarized-capacitor-symbol ()
get-default-capacitor-symbol¶
public defn get-default-capacitor-symbol ()
Related Packages¶
Forwarded by packages: jsl/symbols/generators, jsl/symbols