PortProperties

The S-parameter port properties.

Example

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

    -- Add a line and a wire port at the start of the line

line = project.Geometry:AddLine(cf.Point(0,0,0),cf.Point(1,1,0))
port1 = project.Ports:AddWirePort(line.Wires[1])

    -- Add a S-parameters calculation request for the wire port
    
SParameterConfiguration = 
    project.SolutionConfigurations:AddMultiportSParameter({port1.Terminal})

    -- Add a port to the S-parameters calculation
    
port2 = project.Ports:AddWirePort(line.Wires[1])
port2.Location = cf.Enums.WirePortLocationEnum.End

SParametersRequest = SParameterConfiguration.SParameter

    -- Obtain a handle to the 'PortProperties'

portProperties = SParametersRequest.PortProperties[1]

    -- Set the port inactive
    
portProperties.Active = false

Property List

Active
Specifies if the port is active. (Read/Write boolean)
Impedance
The reference impedance. This property applies to all ports except waveguide ports. (Read/Write Expression)
IndexM
M index. This property only applies for waveguide ports where WaveGuideModeType is set to TE or TM. (Read/Write Expression)
IndexN
N index. This property only applies for waveguide ports where WaveGuideModeType is set to TE or TM. (Read/Write Expression)
Rotation
Waveguide rotation. This property only applies for the coaxial or circular waveguide ports. (Read/Write Expression)
Terminal
The port terminal connected to the S-parameter. (Read/Write Terminal)
WaveguideModeType
The waveguide mode type. The property only applies for waveguide ports. (Read/Write SParameterWaveguideModeTypeEnum)

Property Details

Active
Specifies if the port is active.
Type
boolean
Access
Read/Write
Impedance
The reference impedance. This property applies to all ports except waveguide ports.
Type
Expression
Access
Read/Write
IndexM
M index. This property only applies for waveguide ports where WaveGuideModeType is set to TE or TM.
Type
Expression
Access
Read/Write
IndexN
N index. This property only applies for waveguide ports where WaveGuideModeType is set to TE or TM.
Type
Expression
Access
Read/Write
Rotation
Waveguide rotation. This property only applies for the coaxial or circular waveguide ports.
Type
Expression
Access
Read/Write
Terminal
The port terminal connected to the S-parameter.
Type
Terminal
Access
Read/Write
WaveguideModeType
The waveguide mode type. The property only applies for waveguide ports.
Type
SParameterWaveguideModeTypeEnum
Access
Read/Write