Class: PathComponent

PathComponent(tikzComponentName, instanceNameopt, pins, angleopt, mirrorXopt, mirrorYopt)

Class representing a path-style TikZ component.

Constructor

new PathComponent(tikzComponentName, instanceNameopt, pins, angleopt, mirrorXopt, mirrorYopt)

Generate a PathComponent or -stencil.

Parameters:
Name Type Attributes Default Description
tikzComponentName string

the tikz component name, e.g. "R"

instanceName string <optional>
""

the instance name, e.g. "R1"

pins Array.<Pin>

a list of the two corresponding pins

angle number <optional>
0

the angle to rotate the component

mirrorX boolean <optional>
false

true to mirror on x axis

mirrorY boolean <optional>
false

true to mirror on y axis

Source:

Extends

Members

instanceName

Properties:
Name Type Description
instanceName string

the instance name, e.g. "R1"

Source:

pins

Properties:
Name Type Description
pins Array.<Pin>

a list of the two corresponding pins

Source:

tikzComponentName

Getts the private tikzComponentName.

Source:

Methods

deepClone() → {PathComponent}

Deep clone of this object.

Source:
Returns:

the cloned object

Type
PathComponent

serialize(indentopt) → {string}

Serializes a component. The TikZ "source code" is returned.

Parameters:
Name Type Attributes Default Description
indent number <optional>
0

the indention (= amount of tabs) to use

Source:
Returns:

the serialized component

Type
string

useAsStencil(libraryName, cellName, instanceName, attributes, pins, placement, wires, nets, coords) → {PathComponent}

Generate a TikZ component using this as an stencil. The parameters are informations extracted from ABL.

Parameters:
Name Type Description
libraryName string

the ABL library name, e.g. "ads_rflib"

cellName string

the librarys component name, e.g. "R"

instanceName string

the instance/component name, e.g. "R1"

attributes Map.<string, string>

map of all (XML) attributes

pins Array.<Pin>

the pins with their name and number (position not yet set)

placement Object

general component placement information

wires Array.<Wire>

list of all wires

nets Map.<string, Net>

list of all nets

coords Array.<Coordinate>

list of all coordinates

Source:
Returns:

the new PathComponent

Type
PathComponent