jsl/symbols/decorators¶
Package name: jsl/symbols/decorators
Summary¶
Data Types¶
CardinalityType¶
Functions¶
| Function | Description |
|---|---|
| to-name-string | |
| CardinalityDecorator | Pin Cardinality Decorator |
OpenCollectorType¶
Functions¶
| Function | Description |
|---|---|
| OpenCollectorDecorator | Open Collector Pin Decorator |
| construct-open-collector-shape |
General Definitions¶
| Function | Description |
|---|---|
| construct-output-card-shape | |
| ClockDecorator | Clock Decorator for Internal Pin Identifier. |
| construct-input-card-shape | |
| ActiveLowDecorator | Active-Low (bubble) Pin Decorator |
| default-oc-nudge |
| Variable | Description |
|---|---|
| DEC_OUTSIDE | |
| DEC_INSIDE |
Definitions¶
CardinalityType¶
public defenum CardinalityType <: Equalable & Hashable
-
InputPin -
OutputPin -
BidirectionalPin
Functions¶
to-name-string¶
public defn to-name-string (ct:CardinalityType)
CardinalityDecorator¶
Pin Cardinality Decorator
public defn CardinalityDecorator (cardinality:CardinalityType -- size:Double|Dims = ?, nudge:Pose = ?)
cardinality: CardinalityType- Type of symbol to draw.size: Double|Dims- Size of the constructed arrows.nudge: Pose- Optional modulator of the position of the resulting decorator. By default, this places the shapes outside the symbol body.
This decorator is used to indicate if a pin is a input, output, or bidirectional pin. Note that you can use multiple decorators on a pin if the styling for default bidir is not to your liking.
OpenCollectorType¶
public defenum OpenCollectorType <: Equalable & Hashable
-
OpenCollectorSink- Low Side Open Collector Sink. This is the most common version. This is created using a NPN BJT or NMOS FET. -
OpenCollectorSource- High Side Open Collector Source. Less common - this is created using a PNP BJT or PMOS FET.
Functions¶
OpenCollectorDecorator¶
Open Collector Pin Decorator
public defn OpenCollectorDecorator ( -- width:Double = ?, line-width:Double = ?, oc-type:OpenCollectorType = ?, pullupdown:True|False = ?, nudge:Pose = ?) -> PinDecorator
width: Double- Size of the symbol for both height & widthline-width: Double- Stroke width for the symbol line.oc-type: OpenCollectorType- Determines whether this draws a PNP-sourcing open collector symbol or a NPN-sinking open-collector symbolpullupdown: True|False- Generates the horizontal bar that indicates this pin has an internal pull/up down resistor.- Returns
PinDecorator
construct-open-collector-shape¶
public defn construct-open-collector-shape (width:Double = ?, line-width:Double = ?, oc-type:OpenCollectorType = ?, pullupdown:True|False = ?) -> Shape
- Returns
Shape
General Definitions¶
construct-output-card-shape¶
public defn construct-output-card-shape (size:[Double, Double]) -> Shape
- Returns
Shape
ClockDecorator¶
Clock Decorator for Internal Pin Identifier.
public defn ClockDecorator ( -- size:Double|Dims = ?, line-width:Double = ?) -> PinDecorator
size: Double|Dims- If this value is aDouble- then we just create a angle symbol with equal height and width. IfDimsis passed then we can have separate heigth and width for the clock>symbol.- Returns
PinDecorator
This adds a > style symbol to the internal
body of the component where the pin is instantiated.
construct-input-card-shape¶
public defn construct-input-card-shape (size:[Double, Double]) -> Shape
- Returns
Shape
ActiveLowDecorator¶
Active-Low (bubble) Pin Decorator
public defn ActiveLowDecorator ( -- diam:Double = ?, nudge:Pose = ?) -> PinDecorator
diam: Double- Diameter of the bubble in symbol grid unitsnudge: Pose- By default the bubble is placed on the external edge of the component body, overlapping the base of the pin. This value is a helper to move the bubble so that we can make the symbol look more aesthetically pleasing.- Returns
PinDecorator
default-oc-nudge¶
public defn default-oc-nudge (width:Double) -> Pose
- Returns
Pose
DEC_OUTSIDE¶
public val DEC_OUTSIDE
DEC_INSIDE¶
public val DEC_INSIDE
Related Packages¶
Forwarded by packages: jsl/symbols/framework, jsl/symbols