`SParameterPortPropertiesCollection`

A collection of port properties.

Example

app = cf.GetApplication()
project = app:NewProject()
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
    
sParameterConfig = project.SolutionConfigurations:AddMultiportSParameter({port1.Terminal})

    -- Get the number of port properties
    
count = sParameterConfig.SParameter.PortProperties.Count

Usage locations (collections)

The following objects contain the SParameterPortPropertiesCollection collection:

SParameter(.PortProperties)

Property List

Count: The number of PortProperties items in the collection. (Read only number)

Method List

Add (portterminal TerminalType, impedance Expression, active boolean): Adds a port to the S-parameter's port properties.
Add (portterminal TerminalType, active boolean): Adds a Fundamental mode waveguide port to the S-parameter's port properties.
Add (portterminal TerminalType, indexm number, indexn number, active boolean): Adds a TE mode waveguide port to the S-parameter's port properties.
Item (index number): Returns the PortProperties at the given index. (Returns a PortProperties object.)
Remove (index number): Remove the S-parameter port properties at the given index.

Index List

[number]: Returns the PortProperties at the given index in the collection. (Read PortProperties)

Property Details

Count

The number of PortProperties items in the collection.

Type: number
Access: Read only

Method Details

Add (portterminal TerminalType, impedance Expression, active boolean)

Adds a port to the S-parameter's port properties.

Input Parameters

portterminal(TerminalType): The port terminal.
impedance(Expression): The reference impedance.
active(boolean): Sets the port active.

Add (portterminal TerminalType, active boolean)

Adds a Fundamental mode waveguide port to the S-parameter's port properties.

Input Parameters

portterminal(TerminalType): The port terminal.
active(boolean): Sets the port active.

Add (portterminal TerminalType, indexm number, indexn number, active boolean)

Adds a TE mode waveguide port to the S-parameter's port properties.

Input Parameters

portterminal(TerminalType): The port terminal.
indexm(number): The M index.
indexn(number): The N index.
active(boolean): Sets the port active.

Item (index number)

Returns the PortProperties at the given index.

Input Parameters

index(number): The index of the PortProperties.

Return

PortProperties: The PortProperties at the given index.

Remove (index number)

Remove the S-parameter port properties at the given index.

Input Parameters

index(number): The index of the port to remove.