`SolutionConfigurationCollection`

A collection of solution configurations in the project.

Example

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

    -- Add a line and attach a wire port to it
    
line = project.Geometry:AddLine(cf.Point(0,0,0), cf.Point(0,0,1))
wirePort = project.Ports:AddWirePort(line.Wires[1])

    -- Obtain a handle to the 'SolutionConfigurationCollection'
    
solutionConfigurations = project.SolutionConfigurations    

    -- Use handle to add an S-parameter configuration  
    
SParameterConfiguration = solutionConfigurations:AddMultiportSParameter({wirePort.Terminal})

    -- use handle to set loads to be specified per configuration
    
solutionConfigurations:SetLoadsPerConfiguration()

    -- Add a load to the S-parameter configuration
    
SParameterConfiguration.Loads:AddComplex(wirePort.Terminal,1,0)

Usage locations (collections)

The following objects contain the SolutionConfigurationCollection collection:

Project(.SolutionConfigurations)

Property List

Count: The number of SolutionConfiguration items in the collection. (Read only number)
Type: The object type string. (Read only string)

Method List

AddCharacteristicModes (numberofmodes Expression): Add a characteristic modes configuration. (Returns a CharacteristicModesConfiguration object.)
AddMultiportSParameter (portterminals List of TerminalType): Add a multiport S-parameter configuration. (Returns a SParameterConfiguration object.)
AddStandardConfiguration (): Add a standard configuration. (Returns a StandardConfiguration object.)
Contains (label string): Checks if the collection contains an item with the given label. (Returns a boolean object.)
IsFrequencyPerConfiguration (): Check whether frequency is specified per configuration. (Returns a boolean object.)
IsLoadsPerConfiguration (): Check whether loads are specified per configuration. (Returns a boolean object.)
IsPowerPerConfiguration (): Check whether power is specified per configuration. (Returns a boolean object.)
IsSolutionEnabled (): Check whether the setting of solution parameters is enabled. (Returns a boolean object.)
IsSourcesPerConfiguration (): Check whether sources are specified per configuration. (Returns a boolean object.)
Item (index number): Returns the SolutionConfiguration at the given index. (Returns a SolutionConfiguration object.)
Item (label string): Returns the SolutionConfiguration with the given label. (Returns a SolutionConfiguration object.)
Items (): Returns a table of SolutionConfiguration. (Returns a List of SolutionConfiguration object.)
SetFrequencyGlobal (solutionconfiguration SolutionConfiguration): Specify frequency to be global.
SetFrequencyPerConfiguration (): Specify frequency to be per configuration.
SetLoadsGlobal (solutionconfiguration SolutionConfiguration): Specify loads to be global.
SetLoadsPerConfiguration (): Specify loads to be per configuration.
SetPowerGlobal (solutionconfiguration SolutionConfiguration): Specify power to be global.
SetPowerPerConfiguration (): Specify power to be per configuration.
SetSourcesGlobal (solutionconfiguration SolutionConfiguration): Specify sources to be global.
SetSourcesPerConfiguration (): Specify sources to be per configuration.
UniqueName (label string): Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]: Returns the SolutionConfiguration at the given index in the collection. (Read SolutionConfiguration)
[string]: Returns the SolutionConfiguration with the given name in the collection. (Read SolutionConfiguration)

Property Details

Count

The number of SolutionConfiguration items in the collection.

Type: number
Access: Read only

Type

The object type string.

Type: string
Access: Read only

Method Details

AddCharacteristicModes (numberofmodes Expression)

Add a characteristic modes configuration.

Input Parameters

numberofmodes(Expression): The number of modes to calculate.

Return

CharacteristicModesConfiguration: The solution configuration.

AddMultiportSParameter (portterminals List of TerminalType)

Add a multiport S-parameter configuration.

Input Parameters

portterminals(List of TerminalType): The list of port terminals on which the S-parameters calculation should be done.

Return

SParameterConfiguration: The S-parameter configuration.

AddStandardConfiguration ()

Add a standard configuration.

Return

StandardConfiguration: The standard configuration.

Contains (label string)

Checks if the collection contains an item with the given label.

Input Parameters

label(string): The label of the SolutionConfiguration.

Return

boolean: The success of the check.

IsFrequencyPerConfiguration ()

Check whether frequency is specified per configuration.

Return

boolean: True when frequency is specified per configuration and false when frequency is specified globally.

IsLoadsPerConfiguration ()

Check whether loads are specified per configuration.

Return

boolean: True when loads are specified per configuration and false when loads are specified globally.

IsPowerPerConfiguration ()

Check whether power is specified per configuration.

Return

boolean: True when power is specified per configuration and false when power is specified globally.

IsSolutionEnabled ()

Check whether the setting of solution parameters is enabled.

Return

boolean: True when setting solution parameters is enabled and false when setting solution parameters have been disabled.

IsSourcesPerConfiguration ()

Check whether sources are specified per configuration.

Return

boolean: True when sources are specified per configuration and false when sources are specified globally.

Item (index number)

Returns the SolutionConfiguration at the given index.

Input Parameters

index(number): The index of the SolutionConfiguration.

Return

SolutionConfiguration: The SolutionConfiguration at the given index.

Item (label string)

Returns the SolutionConfiguration with the given label.

Input Parameters

label(string): The label of the SolutionConfiguration.

Return

SolutionConfiguration: The SolutionConfiguration with the given label.

Items ()

Returns a table of SolutionConfiguration.

Return

List of SolutionConfiguration: A table of SolutionConfiguration.

SetFrequencyGlobal (solutionconfiguration SolutionConfiguration)

Specify frequency to be global.

Input Parameters

solutionconfiguration(SolutionConfiguration): The solution configuration to use as source for the global frequency.

SetFrequencyPerConfiguration ()

Specify frequency to be per configuration.

SetLoadsGlobal (solutionconfiguration SolutionConfiguration)

Specify loads to be global.

Input Parameters

solutionconfiguration(SolutionConfiguration): The solution configuration to use as source for the global loads.

SetLoadsPerConfiguration ()

Specify loads to be per configuration.

SetPowerGlobal (solutionconfiguration SolutionConfiguration)

Specify power to be global.

Input Parameters

solutionconfiguration(SolutionConfiguration): The solution configuration to use as source for the global power.

SetPowerPerConfiguration ()

Specify power to be per configuration.

SetSourcesGlobal (solutionconfiguration SolutionConfiguration)

Specify sources to be global.

Input Parameters

solutionconfiguration(SolutionConfiguration): The solution configuration to use as source for the global sources.

SetSourcesPerConfiguration ()

Specify sources to be per configuration.

UniqueName (label string)

Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.

Input Parameters

label(string): The base name.

Return

boolean: The generated unique name label for SolutionConfiguration.