TransmissionLine

An ideal non-radiating transmission line.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Create a transmission lines
    
project.SolutionConfigurations[1].Networks:AddTransmissionLine(10, 50, 25, 10)

Inheritance

The TransmissionLine object is derived from the SolutionEntity object.

Property List

Attenuation
The transmission line losses (dB/m). Only applicable if DefinitionMethod is SpecifiedAttenuation or VelocityOfPropagation. (Read/Write Expression)
DefinitionMethod
The transmission line definition method. (Read/Write TransmissionLineDefinitionMethodEnum)
Included
Specifies whether the solution entity must be included or excluded. (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 Expression)
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 Expression)
Type
The object type string. (Read only string)
Visible
Specifies whether the solution entity must be shown or hidden. (Read/Write boolean)
Z0Imaginary
The imaginary part of the characteristic impedance of the transmission line (Ohm). (Read/Write Expression)
Z0Real
The real part of the characteristic impedance of the transmission line (Ohm). (Read/Write Expression)

Collection List

Terminals
The collection of port terminals on the transmission line. The collection will always contain two port terminals, the input (start) and output (end) ports of the transmission line. (TransmissionLineTerminalCollection of Terminal.)

Method List

Delete ()
Delete the solution entity.
Duplicate ()
Duplicate the solution entity. (Returns a SolutionEntity 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.)
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

Attenuation
The transmission line losses (dB/m). Only applicable if DefinitionMethod is SpecifiedAttenuation or VelocityOfPropagation.
Type
Expression
Access
Read/Write
DefinitionMethod
The transmission line definition method.
Type
TransmissionLineDefinitionMethodEnum
Access
Read/Write
Included
Specifies whether the solution entity must be included or excluded.
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
Expression
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
Expression
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Visible
Specifies whether the solution entity must be shown or hidden.
Type
boolean
Access
Read/Write
Z0Imaginary
The imaginary part of the characteristic impedance of the transmission line (Ohm).
Type
Expression
Access
Read/Write
Z0Real
The real part of the characteristic impedance of the transmission line (Ohm).
Type
Expression
Access
Read/Write

Collection Details

Terminals
The collection of port terminals on the transmission line. The collection will always contain two port terminals, the input (start) and output (end) ports of the transmission line.
Type
TransmissionLineTerminalCollection

Method Details

Delete ()
Delete the solution entity.
Duplicate ()
Duplicate the solution entity.
Return
SolutionEntity
The 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 properties table.
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.