SolutionConfigurationCollection
A collection of solution configurations in the project.
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]) -- Obtain a handle to the 'SolutionConfigurationCollection' solutionConfigurations = project.Contents.SolutionConfigurations -- Use handle to add an S-parameter configuration SParameterConfiguration = solutionConfigurations:AddMultiportSParameter({wirePort}) -- use handle to set loads to be specified per configuration solutionConfigurations:SetLoadsPerConfiguration() -- Add a load to the S-parameter configuration SParameterConfiguration.Loads:AddComplex(wirePort,1,0)
Inheritance
The SolutionConfigurationCollection object is derived from the Object object.
Usage locations
The SolutionConfigurationCollection object can be accessed from the following locations:
- Collection lists
- ModelContents object has collection SolutionConfigurations.
Property List
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- Count
- The number of SolutionConfiguration items in the collection. (Read only number)
- GlobalFrequency
- The global solution frequency range. (Read only Frequency)
- GlobalPower
- The global power settings. (Read only Power)
- IsFrequencyPerConfiguration
- Whether frequency is specified per configuration. (Read only boolean)
- IsLoadsPerConfiguration
- Whether loads are specified per configuration. (Read only boolean)
- IsPowerPerConfiguration
- Whether power is specified per configuration. (Read only boolean)
- IsSourcesPerConfiguration
- Whether sources are specified per configuration. (Read only boolean)
- Label
- The object label. (Read/Write string)
- Type
- The object type string. (Read only string)
Collection List
- GlobalLoads
- The global collection of loads. (LoadCollection of Load.)
- GlobalNetworks
- The global collection of non-radiating networks. (NetworkCollection of Network.)
- GlobalSources
- The global collection of solution sources. (SourceCollection of Source.)
Method List
- AddCharacteristicModes (numberofmodes Expression)
- Add a characteristic modes configuration. (Returns a CharacteristicModesConfiguration object.)
- AddMultiportSParameter (portterminals List of Port)
- Add a multiport S-parameter configuration. (Returns a SParameterConfiguration object.)
- AddStandardConfiguration ()
- Add a standard configuration. (Returns a StandardConfiguration object.)
- 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.)
- Item (index number)
- Returns the SolutionConfiguration for the given index in the collection. (Returns a SolutionConfiguration object.)
- Item (label string)
- Returns the SolutionConfiguration for the given label in the collection. (Returns a SolutionConfiguration object.)
- Items ()
- Returns a table of SolutionConfiguration items. (Returns a UnsupportedType(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.
- 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.
- SetSourcesGlobal (solutionconfiguration SolutionConfiguration)
- Specify sources to be global.
- SetSourcesPerConfiguration ()
- Specify sources to be per configuration.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box).
- Type
- Box
- Access
- Read only
- Count
- The number of SolutionConfiguration items in the collection.
- Type
- number
- Access
- Read only
- GlobalFrequency
- The global solution frequency range.
- Type
- Frequency
- Access
- Read only
- GlobalPower
- The global power settings.
- Type
- Power
- Access
- Read only
- IsFrequencyPerConfiguration
- Whether frequency is specified per configuration.
- Type
- boolean
- Access
- Read only
- IsLoadsPerConfiguration
- Whether loads are specified per configuration.
- Type
- boolean
- Access
- Read only
- IsPowerPerConfiguration
- Whether power is specified per configuration.
- Type
- boolean
- Access
- Read only
- IsSourcesPerConfiguration
- Whether sources are specified per configuration.
- Type
- boolean
- Access
- Read only
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Collection Details
- GlobalLoads
- The global collection of loads.
- Type
- LoadCollection
- GlobalNetworks
- The global collection of non-radiating networks.
- Type
- NetworkCollection
- GlobalSources
- The global collection of solution sources.
- Type
- SourceCollection
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 Port)
- Add a multiport S-parameter configuration.
- Input Parameters
- Return
- SParameterConfiguration
- The S-parameter configuration.
- AddStandardConfiguration ()
- Add a standard configuration.
- Return
- StandardConfiguration
- The standard configuration.
- 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.
- Item (index number)
- Returns the SolutionConfiguration for the given index in the collection.
- Input Parameters
- index(number)
- The index of the SolutionConfiguration.
- Return
- SolutionConfiguration
- The item in the collection
- Item (label string)
- Returns the SolutionConfiguration for the given label in the collection.
- Input Parameters
- label(string)
- The label of the SolutionConfiguration.
- Return
- SolutionConfiguration
- The item in the collection
- Items ()
- Returns a table of SolutionConfiguration items.
- Return
- UnsupportedType(List of SolutionConfiguration)
- The list of items in the collection
- 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.
- 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.
- 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.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.