ConfigurationCollection

A collection of configurations within a model.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/multiple_configurations.fek]])

    -- Get the first configuration in the configuration collection
    
standardLoadConfiguration = app.Models[1].Configurations[1]

    -- Get the other configuration in the configuration collection by name 
    
largeLoadConfiguration = app.Models[1].Configurations["LargeLoad"]

    -- Compare the two configurations' far fields 
    
graph = app.CartesianGraphs:Add()
standardLoadFarFieldTrace = graph.Traces:Add(standardLoadConfiguration.FarFields[1])
largeLoadFarFieldTrace = graph.Traces:Add(largeLoadConfiguration.FarFields[1])

Usage locations (collections)

The following objects contain the ConfigurationCollection collection:

Property List

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

Method List

Contains (label string)
Checks if the collection contains an item with the given label. (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.)
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

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.
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.
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.