CableSchematicComponentCollection

A collection of cable schematic components.

Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]])

    -- Get an existing 'CableHarness'

cableHarness = project.Cables.Harnesses["CableHarness1"]

    -- Get the number of schematic components associated with a 'CableHarness'

componentCount = cableHarness.SchematicComponents.Count

    -- Add a capacitor to between two terminals

terminal1 = cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal
terminal2 = cableHarness.Connectors["CableConnector2"].Pins["Pin1"].Terminal
capacitor = cableHarness.SchematicComponents:AddCapacitor(terminal1, terminal2, 1e-6)

Usage locations (collections)

The following objects contain the CableSchematicComponentCollection collection:

Property List

Count
The number of CableSchematicComponent items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

AddCapacitor (terminal1 Terminal, terminal2 Terminal, capacitance Expression)
Add a new capacitor to the cable harness schematic. (Returns a CableCapacitor object.)
AddCapacitor (properties table)
Add a new capacitor to the cable harness schematic. (Returns a CableCapacitor object.)
AddComplexLoad (terminal1 Terminal, terminal2 Terminal, real Expression, imaginary Expression)
Add a new complex load to the cable harness schematic. (Returns a CableComplexLoad object.)
AddComplexLoad (properties table)
Add a new complex load to the cable harness schematic. (Returns a CableComplexLoad object.)
AddCurrentProbe (terminal1 Terminal, terminal2 Terminal)
Add a new current probe to the cable harness schematic. (Returns a CableSchematicCurrentProbe object.)
AddCurrentProbe (properties table)
Add a new current probe to the cable harness schematic. (Returns a CableSchematicCurrentProbe object.)
AddGeneralNetwork (numports number, filename string)
Add a new general network to the cable harness schematic. (Returns a CableGeneralNetwork object.)
AddGeneralNetwork (properties table)
Add a new general network to the cable harness schematic. (Returns a CableGeneralNetwork object.)
AddGround (terminal Terminal)
Add a new ground to the cable harness schematic. (Returns a CableGround object.)
AddGround (properties table)
Add a new ground to the cable harness schematic. (Returns a CableGround object.)
AddInductor (terminal1 Terminal, terminal2 Terminal, inductance Expression)
Add a new inductor to the cable harness schematic. (Returns a CableInductor object.)
AddInductor (properties table)
Add a new inductor to the cable harness schematic. (Returns a CableInductor object.)
AddResistor (terminal1 Terminal, terminal2 Terminal, resistance Expression)
Add a new resistor to the cable harness schematic. (Returns a CableResistor object.)
AddResistor (properties table)
Add a new resistor to the cable harness schematic. (Returns a CableResistor object.)
AddSpiceNetwork (numpins number, circuit string)
Add a new SPICE circuit to the cable harness schematic. (Returns a CableSpiceNetwork object.)
AddSpiceNetwork (properties table)
Add a new SPICE network to the cable harness schematic. (Returns a CableSpiceNetwork object.)
AddSpiceNetworkFromFile (numpins number, filename string)
Add a new SPICE circuit to the cable harness schematic. (Returns a CableSpiceNetwork object.)
AddTransformer (terminal1 Terminal, terminal2 Terminal, terminal3 Terminal, terminal4 Terminal, coupledinductor1 Expression, coupledinductor2 Expression)
Add a new transformer to the cable harness schematic. (Returns a CableTransformer object.)
AddTransformer (properties table)
Add a new transformer to the cable harness schematic. (Returns a CableTransformer object.)
AddVoltageControlledVoltageSource (terminal1 Terminal, terminal2 Terminal, terminal3 Terminal, terminal4 Terminal, gain Expression)
Add a new voltage controlled voltage source to the cable harness schematic. (Returns a CableVoltageControlledVoltageSource object.)
AddVoltageControlledVoltageSource (properties table)
Add a new voltage controlled voltage source to the cable harness schematic. (Returns a CableVoltageControlledVoltageSource object.)
AddVoltageProbe (terminal1 Terminal, terminal2 Terminal)
Add a new voltage probe to the cable harness schematic. (Returns a CableSchematicVoltageProbe object.)
AddVoltageProbe (properties table)
Add a new voltage probe to the cable harness schematic. (Returns a CableSchematicVoltageProbe object.)
AddVoltageSource (terminal1 Terminal, terminal2 Terminal, magnitude Expression, phase Expression, impedance Expression)
Add a new cable port to the cable harness schematic and attaches a new voltage source. Consider using the API method AddCablePort on the PortCollection instead. (Returns a CableSchematicPort object.)
AddVoltageSource (properties table)
Add a new cable port to the cable harness schematic and attaches a new voltage source. Consider using the API method AddCablePort on the PortCollection instead. (Returns a CableSchematicPort object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the CableSchematicComponent at the given index. (Returns a CableSchematicComponent object.)
Item (label string)
Returns the CableSchematicComponent with the given label. (Returns a CableSchematicComponent object.)
Items ()
Returns a table of CableSchematicComponent. (Returns a List of CableSchematicComponent object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]
Returns the CableSchematicComponent at the given index in the collection. (Read CableSchematicComponent)
[string]
Returns the CableSchematicComponent with the given name in the collection. (Read CableSchematicComponent)

Property Details

Count
The number of CableSchematicComponent items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

AddCapacitor (terminal1 Terminal, terminal2 Terminal, capacitance Expression)
Add a new capacitor to the cable harness schematic.
Input Parameters
terminal1(Terminal)
The terminal that the components first terminal should be connected to. Can be nil.
terminal2(Terminal)
The terminal that the components second terminal should be connected to. Can be nil.
capacitance(Expression)
The capacitance of the capacitor in Farad.
Return
CableCapacitor
The new capacitor component.
AddCapacitor (properties table)
Add a new capacitor to the cable harness schematic.
Input Parameters
properties(table)
A table of properties defining the new component.
Return
CableCapacitor
The new component.
AddComplexLoad (terminal1 Terminal, terminal2 Terminal, real Expression, imaginary Expression)
Add a new complex load to the cable harness schematic.
Input Parameters
terminal1(Terminal)
The terminal that the components first terminal should be connected to. Can be nil.
terminal2(Terminal)
The terminal that the components second terminal should be connected to. Can be nil.
real(Expression)
The real impedance of the complex load in Ohm.
imaginary(Expression)
The imaginary impedance of the complex load in Ohm.
Return
CableComplexLoad
The new complex load component.
AddComplexLoad (properties table)
Add a new complex load to the cable harness schematic.
Input Parameters
properties(table)
A table of properties defining the new component.
Return
CableComplexLoad
The new component.
AddCurrentProbe (terminal1 Terminal, terminal2 Terminal)
Add a new current probe to the cable harness schematic.
Input Parameters
terminal1(Terminal)
The terminal that the components first terminal should be connected to. Can be nil.
terminal2(Terminal)
The terminal that the components second terminal should be connected to. Can be nil.
Return
CableSchematicCurrentProbe
The new current probe component.
AddCurrentProbe (properties table)
Add a new current probe to the cable harness schematic.
Input Parameters
properties(table)
A table of properties defining the new component.
Return
CableSchematicCurrentProbe
The new component.
AddGeneralNetwork (numports number, filename string)
Add a new general network to the cable harness schematic.
Input Parameters
numports(number)
The number of ports.
filename(string)
The general network touchstone filename.
Return
CableGeneralNetwork
The new general network.
AddGeneralNetwork (properties table)
Add a new general network to the cable harness schematic.
Input Parameters
properties(table)
A table of properties defining the new component.
Return
CableGeneralNetwork
The new component.
AddGround (terminal Terminal)
Add a new ground to the cable harness schematic.
Input Parameters
terminal(Terminal)
The terminal that the ground should be connected to. Can be nil.
Return
CableGround
The new ground component.
AddGround (properties table)
Add a new ground to the cable harness schematic.
Input Parameters
properties(table)
A table of properties defining the new component.
Return
CableGround
The new component.
AddInductor (terminal1 Terminal, terminal2 Terminal, inductance Expression)
Add a new inductor to the cable harness schematic.
Input Parameters
terminal1(Terminal)
The terminal that the components first terminal should be connected to. Can be nil.
terminal2(Terminal)
The terminal that the components second terminal should be connected to. Can be nil.
inductance(Expression)
The inductance of the inductor in Henry.
Return
CableInductor
The new inductor component.
AddInductor (properties table)
Add a new inductor to the cable harness schematic.
Input Parameters
properties(table)
A table of properties defining the new component.
Return
CableInductor
The new component.
AddResistor (terminal1 Terminal, terminal2 Terminal, resistance Expression)
Add a new resistor to the cable harness schematic.
Input Parameters
terminal1(Terminal)
The terminal that the components first terminal should be connected to. Can be nil.
terminal2(Terminal)
The terminal that the components second terminal should be connected to. Can be nil.
resistance(Expression)
The resistance of the resistor in Ohm.
Return
CableResistor
The new resistor component.
AddResistor (properties table)
Add a new resistor to the cable harness schematic.
Input Parameters
properties(table)
A table of properties defining the new component.
Return
CableResistor
The new component.
AddSpiceNetwork (numpins number, circuit string)
Add a new SPICE circuit to the cable harness schematic.
Input Parameters
numpins(number)
The number of pins.
circuit(string)
The spice circuit.
Return
CableSpiceNetwork
The new spice circuit.
AddSpiceNetwork (properties table)
Add a new SPICE network to the cable harness schematic.
Input Parameters
properties(table)
A table of properties defining the new component.
Return
CableSpiceNetwork
The new component.
AddSpiceNetworkFromFile (numpins number, filename string)
Add a new SPICE circuit to the cable harness schematic.
Input Parameters
numpins(number)
The number of pins.
filename(string)
The spice circuit filename.
Return
CableSpiceNetwork
The new spice circuit.
AddTransformer (terminal1 Terminal, terminal2 Terminal, terminal3 Terminal, terminal4 Terminal, coupledinductor1 Expression, coupledinductor2 Expression)
Add a new transformer to the cable harness schematic.
Input Parameters
terminal1(Terminal)
The terminal that the components first L1 terminal should be connected to. Can be nil.
terminal2(Terminal)
The terminal that the components second L1 terminal should be connected to. Can be nil.
terminal3(Terminal)
The terminal that the components first L2 terminal should be connected to. Can be nil.
terminal4(Terminal)
The terminal that the components second L2 terminal should be connected to. Can be nil.
coupledinductor1(Expression)
The inductance of the L1 coupled inductor.
coupledinductor2(Expression)
The inductance of the L1 coupled inductor.
Return
CableTransformer
The new transformer component.
AddTransformer (properties table)
Add a new transformer to the cable harness schematic.
Input Parameters
properties(table)
A table of properties defining the new component.
Return
CableTransformer
The new component.
AddVoltageControlledVoltageSource (terminal1 Terminal, terminal2 Terminal, terminal3 Terminal, terminal4 Terminal, gain Expression)
Add a new voltage controlled voltage source to the cable harness schematic.
Input Parameters
terminal1(Terminal)
The terminal that the source's positive terminal should be connected to. Can be nil.
terminal2(Terminal)
The terminal that the source's negative terminal should be connected to. Can be nil.
terminal3(Terminal)
The terminal that the component's positive probe terminal should be connected to. Can be nil.
terminal4(Terminal)
The terminal that the component's negative probe terminal should be connected to. Can be nil.
gain(Expression)
The voltage gain as a ratio.
Return
CableVoltageControlledVoltageSource
The new voltage controlled voltage source component.
AddVoltageControlledVoltageSource (properties table)
Add a new voltage controlled voltage source to the cable harness schematic.
Input Parameters
properties(table)
A table of properties defining the new component.
Return
CableVoltageControlledVoltageSource
The new component.
AddVoltageProbe (terminal1 Terminal, terminal2 Terminal)
Add a new voltage probe to the cable harness schematic.
Input Parameters
terminal1(Terminal)
The terminal that the components first terminal should be connected to. Can be nil.
terminal2(Terminal)
The terminal that the components second terminal should be connected to. Can be nil.
Return
CableSchematicVoltageProbe
The new voltage probe component.
AddVoltageProbe (properties table)
Add a new voltage probe to the cable harness schematic.
Input Parameters
properties(table)
A table of properties defining the new component.
Return
CableSchematicVoltageProbe
The new component.
AddVoltageSource (terminal1 Terminal, terminal2 Terminal, magnitude Expression, phase Expression, impedance Expression)
Add a new cable port to the cable harness schematic and attaches a new voltage source. Consider using the API method AddCablePort on the PortCollection instead.
Input Parameters
terminal1(Terminal)
The terminal that the components first terminal should be connected to. Can be nil.
terminal2(Terminal)
The terminal that the components second terminal should be connected to. Can be nil.
magnitude(Expression)
The magnitude of the voltage in Volts.
phase(Expression)
The phase of the voltage in degrees.
impedance(Expression)
The impedance of the source in Ohms.
Return
CableSchematicPort
The new cable port component.
AddVoltageSource (properties table)
Add a new cable port to the cable harness schematic and attaches a new voltage source. Consider using the API method AddCablePort on the PortCollection instead.
Input Parameters
properties(table)
A table of properties defining the new component.
Return
CableSchematicPort
The new component.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the CableSchematicComponent.
Return
boolean
The success of the check.
Item (index number)
Returns the CableSchematicComponent at the given index.
Input Parameters
index(number)
The index of the CableSchematicComponent.
Return
CableSchematicComponent
The CableSchematicComponent at the given index.
Item (label string)
Returns the CableSchematicComponent with the given label.
Input Parameters
label(string)
The label of the CableSchematicComponent.
Return
CableSchematicComponent
The CableSchematicComponent with the given label.
Items ()
Returns a table of CableSchematicComponent.
Return
List of CableSchematicComponent
A table of CableSchematicComponent.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for CableSchematicComponent.