`SParameterConfiguration`

An S-parameter configuration.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

    -- Add a line and attach a wire port to it

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

    -- Add an S-parameter configuration

SParameterConfiguration = project.Contents.SolutionConfigurations:AddMultiportSParameter({wirePort})

Inheritance

The SParameterConfiguration object is derived from the SolutionConfiguration object.

Usage locations

The SParameterConfiguration object can be accessed from the following locations:

Methods
- SolutionConfigurationCollection collection has method AddMultiportSParameter(List of Port).

Property List

Frequency: The configuration solution frequency. (Read only Frequency)
Included: A boolean value defining if an entity is excluded or included. (Read/Write boolean)
Label: The object label. (Read/Write string)
SParameter: The configuration solution S-parameter. (Read only SParameter)
Type: The object type string. (Read only string)

Collection List

Currents: The collection of currents requests in the configuration. (CurrentsCollection of Currents.)
ErrorEstimations: The collection of error estimations in the configuration. (ErrorEstimationCollection of ErrorEstimation.)
FarFieldReceivingAntennas: The collection of far field receiving antennas in the configuration. (FarFieldReceivingAntennaCollection of FarFieldReceivingAntenna.)
FarFields: The collection of far field requests in the configuration. (FarFieldCollection of FarField.)
Loads: The collection of loads in the configuration. (LoadCollection of Load.)
ModelDecompositions: The collection of model decomposition requests in the configuration. (ModelDecompositionCollection of ModelDecomposition.)
NearFieldReceivingAntennas: The collection of near field receiving antennas in the configuration. (NearFieldReceivingAntennaCollection of NearFieldReceivingAntenna.)
NearFields: The collection of near field requests in the configuration. (NearFieldCollection of NearField.)
SAR: The collection of SAR requests in the configuration. (SARCollection of SAR.)
SphericalModeReceivingAntennas: The collection of spherical mode receiving antennas in the configuration. (SphericalModeReceivingAntennaCollection of SphericalModeReceivingAntenna.)

Method List

Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object 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 Object): 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

Frequency

The configuration solution frequency.

Type: Frequency
Access: Read only

Included

A boolean value defining if an entity is excluded or included.

Type: boolean
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

SParameter

The configuration solution S-parameter.

Type: SParameter
Access: Read only

Type

The object type string.

Type: string
Access: Read only

Collection Details

Currents

The collection of currents requests in the configuration.

Type: CurrentsCollection

ErrorEstimations

The collection of error estimations in the configuration.

Type: ErrorEstimationCollection

FarFieldReceivingAntennas

The collection of far field receiving antennas in the configuration.

Type: FarFieldReceivingAntennaCollection

FarFields

The collection of far field requests in the configuration.

Type: FarFieldCollection

Loads

The collection of loads in the configuration.

Type: LoadCollection

ModelDecompositions

The collection of model decomposition requests in the configuration.

Type: ModelDecompositionCollection

NearFieldReceivingAntennas

The collection of near field receiving antennas in the configuration.

Type: NearFieldReceivingAntennaCollection

NearFields

The collection of near field requests in the configuration.

Type: NearFieldCollection

SAR

The collection of SAR requests in the configuration.

Type: SARCollection

SphericalModeReceivingAntennas

The collection of spherical mode receiving antennas in the configuration.

Type: SphericalModeReceivingAntennaCollection

Method Details

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (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 table defining the properties.

SetProperties (properties Object)

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(Object): 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: A table containing the default properties.