Transformer
A cable transformer component.
Example
application = cf.Application.GetInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) -- Add a transformer cableHarness = project.Contents.CableHarnesses["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.CableSchematic.Components:AddTransformer( inductor1Terminal1, inductor1Terminal2, inductor2Terminal1, inductor2Terminal2, 1e-6, 2e-6) -- Change the transformers coupling coefficient cableHarness.CableSchematic.Components["T1"].CouplingCoefficient = 0.8
Inheritance
The Transformer object is derived from the Object object.
Usage locations
The Transformer object can be accessed from the following locations:
- Methods
- CableSchematicComponentCollection collection has method AddTransformer(table).
- CableSchematicComponentCollection collection has method AddTransformer(Terminal, Terminal, Terminal, Terminal, Expression, Expression).
Property List
- CoupledInductor1
- The value of coupled inductor 1 in Henry. (Read/Write ParametricExpression)
- CoupledInductor2
- The value of coupled inductor 2 in Henry. (Read/Write ParametricExpression)
- CouplingCoefficient
- The coupling coefficient between the two inductors as a ratio. (Read/Write ParametricExpression)
- 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)
- Schematic
- The schematic associated with this item. (Read only Schematic)
- SchematicLocation
- The location of the item on the schematic. (Read only GridLocation)
- SchematicRotation
- The rotation of the item on the schematic. (Read only SymbolRotationEnum)
- Terminals
- The schematic terminals on this item. (Read only List of Terminal)
- Type
- The object type string. (Read only string)
- VoltageProbeEnabled
- True if a current probe must be applied to the component. (Read/Write boolean)
Method List
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object object.)
- 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.)
- RotateSchematicSymbol ()
- Rotates the item on the schematic.
- SetProperties (properties Object)
- 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.
- SetSchematicLocation (location GridLocation)
- Sets the location of the item on the schematic.
- SetSchematicRotation (rotation SymbolRotationEnum)
- Sets the rotation of the item on the schematic.
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
- ParametricExpression
- Access
- Read/Write
- CoupledInductor2
- The value of coupled inductor 2 in Henry.
- Type
- ParametricExpression
- Access
- Read/Write
- CouplingCoefficient
- The coupling coefficient between the two inductors as a ratio.
- Type
- ParametricExpression
- 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
- Schematic
- The schematic associated with this item.
- Type
- Schematic
- Access
- Read only
- SchematicLocation
- The location of the item on the schematic.
- Type
- GridLocation
- Access
- Read only
- SchematicRotation
- The rotation of the item on the schematic.
- Type
- SymbolRotationEnum
- Access
- Read only
- Terminals
- The schematic terminals on this item.
- 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
Method Details
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (duplicated) entity.
- 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 table defining the properties.
- RotateSchematicSymbol ()
- Rotates the item on the schematic.
- SetProperties (properties Object)
- 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(Object)
- A table of properties defining the new state of the object.
- SetSchematicLocation (location GridLocation)
- Sets the location of the item on the schematic.
- Input Parameters
- location(GridLocation)
- The schematic location the item should be moved to.
- SetSchematicRotation (rotation SymbolRotationEnum)
- Sets the rotation of the item on the schematic.
- Input Parameters
- rotation(SymbolRotationEnum)
- The rotation setting.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.