TransmissionLine

An ideal non-radiating transmission line.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

    -- Create a transmission lines

project.Contents.SolutionConfigurations.GlobalNetworks:AddTransmissionLine(10, 50, 25, 10)

Inheritance

The TransmissionLine object is derived from the Network object.

Usage locations

The TransmissionLine object can be accessed from the following locations:

Property List

Attenuation
The transmission line losses (dB/m). Only applicable if DefinitionMethod is SpecifiedAttenuation or VelocityOfPropagation. (Read/Write ParametricExpression)
DefinitionMethod
The transmission line definition method. (Read/Write TransmissionLineDefinitionMethodEnum)
Included
A boolean value defining if an entity is excluded or included. (Read/Write boolean)
InputOutputCrossed
Cross input and output ports. (Read/Write boolean)
Label
The object label. (Read/Write string)
LengthDetermined
Determine length from position. (Read/Write boolean)
LineLength
The transmission line length. This property is not valid when LengthDetermined is true. (Read/Write ParametricExpression)
Medium
The dielectric medium used as the background medium for the transmission line. Only applicable if DefinitionMethod is MediumAttenuation. (Read/Write Medium)
PropagationVelocity
The propagation speed through the transmission line relative to the speed of light. Only applicable if DefinitionMethod is VelocityOfPropagation. (Read/Write ParametricExpression)
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)
Z0Imaginary
The imaginary part of the characteristic impedance of the transmission line (Ohm). (Read/Write ParametricExpression)
Z0Real
The real part of the characteristic impedance of the transmission line (Ohm). (Read/Write ParametricExpression)

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

Attenuation
The transmission line losses (dB/m). Only applicable if DefinitionMethod is SpecifiedAttenuation or VelocityOfPropagation.
Type
ParametricExpression
Access
Read/Write
DefinitionMethod
The transmission line definition method.
Type
TransmissionLineDefinitionMethodEnum
Access
Read/Write
Included
A boolean value defining if an entity is excluded or included.
Type
boolean
Access
Read/Write
InputOutputCrossed
Cross input and output ports.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
LengthDetermined
Determine length from position.
Type
boolean
Access
Read/Write
LineLength
The transmission line length. This property is not valid when LengthDetermined is true.
Type
ParametricExpression
Access
Read/Write
Medium
The dielectric medium used as the background medium for the transmission line. Only applicable if DefinitionMethod is MediumAttenuation.
Type
Medium
Access
Read/Write
PropagationVelocity
The propagation speed through the transmission line relative to the speed of light. Only applicable if DefinitionMethod is VelocityOfPropagation.
Type
ParametricExpression
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
Z0Imaginary
The imaginary part of the characteristic impedance of the transmission line (Ohm).
Type
ParametricExpression
Access
Read/Write
Z0Real
The real part of the characteristic impedance of the transmission line (Ohm).
Type
ParametricExpression
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.