CableTransformer

A cable transformer component.

Example

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

    -- Add a transformer

cableHarness = project.Cables.Harnesses["CableHarness1"]
inductor1Terminal1 = cableHarness.Connectors["CableConnector1"].Pins["Pin1"].Terminal
inductor1Terminal2 = cableHarness.Connectors["CableConnector1"].Pins["Pin2"].Terminal
inductor2Terminal1 = cableHarness.Connectors["CableConnector2"].Pins["Pin1"].Terminal
inductor2Terminal2 = cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal
transformer = cableHarness.SchematicComponents:AddTransformer(
    inductor1Terminal1, inductor1Terminal2, inductor2Terminal1, inductor2Terminal2, 1e-6, 2e-6)

    -- Change the transformers coupling coefficient

cableHarness.SchematicComponents["T1"].CouplingCoefficient = 0.8

Inheritance

The CableTransformer object is derived from the CableSchematicComponent object.

Property List

CoupledInductor1
The value of coupled inductor 1 in Henry. (Read/Write Expression)
CoupledInductor2
The value of coupled inductor 2 in Henry. (Read/Write Expression)
CouplingCoefficient
The coupling coefficient between the two inductors as a ratio. (Read/Write Expression)
CurrentProbeEnabled
True if a current probe must be applied to the component. (Read/Write boolean)
Label
The object label. (Read/Write string)
PhaseDefinition
The phase orientation definition between the two coupled inductors. (Read/Write CableTransformerPhaseDefinitionEnum)
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

CoupledInductor1
The value of coupled inductor 1 in Henry.
Type
Expression
Access
Read/Write
CoupledInductor2
The value of coupled inductor 2 in Henry.
Type
Expression
Access
Read/Write
CouplingCoefficient
The coupling coefficient between the two inductors as a ratio.
Type
Expression
Access
Read/Write
CurrentProbeEnabled
True if a current probe must be applied to the component.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
PhaseDefinition
The phase orientation definition between the two coupled inductors.
Type
CableTransformerPhaseDefinitionEnum
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.