SParameter

A solution S-parameter request.

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
SParametersRequest.PortProperties:Add(port2.Terminal, 60, true)

Inheritance

The SParameter object is derived from the SolutionEntity object.

Usage locations (object properties)

The following objects have properties using the SParameter object:

Property List

Included
Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
Label
The object label. (Read/Write string)
LoadsRestored
Specifies if the loads are restored after calculation. (Read/Write boolean)
TouchstoneExportEnabled
Specifies if the S-parameters should be exported to a Touchstone (*.snp) file. (Read/Write boolean)
Type
The object type string. (Read only string)
Visible
Specifies whether the solution entity must be shown or hidden. (Read/Write boolean)

Collection List

PortProperties
The collection of port properties for the S-parameter request. (SParameterPortPropertiesCollection of PortProperties.)

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

Included
Specifies whether the solution entity must be included or excluded.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
LoadsRestored
Specifies if the loads are restored after calculation.
Type
boolean
Access
Read/Write
TouchstoneExportEnabled
Specifies if the S-parameters should be exported to a Touchstone (*.snp) file.
Type
boolean
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

Collection Details

PortProperties
The collection of port properties for the S-parameter request.
Type
SParameterPortPropertiesCollection

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.