PortProperties
The S-parameter port properties.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Add a line and a wire port at the start of the line line = project.Contents.Geometry:AddLine(cf.Point(0,0,0),cf.Point(1,1,0)) port1 = project.Contents.Ports:AddWirePort(line.Wires[1]) -- Add an S-parameters calculation request for the wire port SParameterConfiguration = project.Contents.SolutionConfigurations:AddMultiportSParameter({port1}) -- Add a port to the S-parameters calculation port2 = project.Contents.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
Inheritance
The PortProperties object is derived from the CompositeValue object.
Usage locations
The PortProperties object can be accessed from the following locations:
- Methods
- PortPropertiesList object has method Append().
- PortPropertiesList object has method Get(number).
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 ParametricExpression)
- IndexM
- M index. This property only applies for waveguide ports where WaveGuideModeType is set to TE or TM. (Read/Write ParametricExpression)
- IndexN
- N index. This property only applies for waveguide ports where WaveGuideModeType is set to TE or TM. (Read/Write ParametricExpression)
- Rotation
- Waveguide rotation. This property only applies for the coaxial or circular waveguide ports. (Read/Write ParametricExpression)
- Terminal
- The port terminal connected to the S-parameter. (Read/Write Port)
- 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
- ParametricExpression
- Access
- Read/Write
- IndexM
- M index. This property only applies for waveguide ports where WaveGuideModeType is set to TE or TM.
- Type
- ParametricExpression
- Access
- Read/Write
- IndexN
- N index. This property only applies for waveguide ports where WaveGuideModeType is set to TE or TM.
- Type
- ParametricExpression
- Access
- Read/Write
- Rotation
- Waveguide rotation. This property only applies for the coaxial or circular waveguide ports.
- Type
- ParametricExpression
- Access
- Read/Write
- Terminal
- The port terminal connected to the S-parameter.
- Type
- Port
- Access
- Read/Write
- WaveguideModeType
- The waveguide mode type. The property only applies for waveguide ports.
- Type
- SParameterWaveguideModeTypeEnum
- Access
- Read/Write