CableInductor
A cable inductor component.
Example
app = cf.GetApplication() project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]) -- Add a 1mH inductor cableHarness = project.Cables.Harnesses["CableHarness1"] terminal1 = cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal terminal2 = cableHarness.Connectors["CableConnector2"].Pins["Pin1"].Terminal inductor = cableHarness.SchematicComponents:AddInductor(terminal1, terminal2, 1e-3) -- Change the inductor's inductance cableHarness.SchematicComponents["L1"].Inductance = 5e-3
Inheritance
The CableInductor object is derived from the CableSchematicComponent object.
Property List
- CurrentProbeEnabled
- True if a current probe must be applied to the component. (Read/Write boolean)
- Inductance
- The inductance of the inductor in Henry. (Read/Write Expression)
- Label
- The object label. (Read/Write string)
- Position
- The schematic symbol position. (Read only SchematicSymbolPosition)
- Type
- The object type string. (Read only string)
- VoltageProbeEnabled
- True if a current probe must be applied to the component. (Read/Write boolean)
Collection List
- Terminals
- The collection of schematic terminals on the symbol. (TerminalCollection of Terminal.)
Method List
- Delete ()
- Deletes the component from the cable schematic.
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
- Rotate ()
- Rotates the symbol 90 degrees clockwise.
- SetProperties (properties table)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- CurrentProbeEnabled
- True if a current probe must be applied to the component.
- Type
- boolean
- Access
- Read/Write
- Inductance
- The inductance of the inductor in Henry.
- Type
- Expression
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Position
- The schematic symbol position.
- Type
- SchematicSymbolPosition
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
- VoltageProbeEnabled
- True if a current probe must be applied to the component.
- Type
- boolean
- Access
- Read/Write
Collection Details
- Terminals
- The collection of schematic terminals on the symbol.
- Type
- TerminalCollection
Method Details
- Delete ()
- Deletes the component from the cable schematic.
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
- Return
- table
- A properties table.
- Rotate ()
- Rotates the symbol 90 degrees clockwise.
- SetProperties (properties table)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- Input Parameters
- properties(table)
- A table of properties defining the new state of the object.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- The default properties table.