SParameterCollection

A collection of S-parameter results.

Example

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

sParameterCollection = app.Models[1].Configurations["SParameterConfiguration1"].SParameters

    -- Add the first S-Parameter to a Cartesian graph 
    
graph = app.CartesianGraphs:Add()
sParameterTrace1 = graph.Traces:Add(sParameterCollection[1]) -- Index method
sParameterTrace2 = graph.Traces:Add(sParameterCollection["SParameter1"]) -- Name method

    -- Add all the S-Parameters in the collection to the graph

for index, sParameterData in pairs(sParameterCollection) do
    sParameterTrace = graph.Traces:Add(sParameterData)
end

Usage locations

The SParameterCollection object can be accessed from the following locations:

Property List

Count
The number of SParameterData 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 SParameterData at the given index. (Returns a SParameterData object.)
Item (label string)
Returns the SParameterData with the given label. (Returns a SParameterData object.)
Items ()
Returns a table of SParameterData. (Returns a List of SParameterData 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 SParameterData at the given index in the collection. (Read SParameterData)
[string]
Returns the SParameterData with the given name in the collection. (Read SParameterData)

Property Details

Count
The number of SParameterData 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 SParameterData.
Return
boolean
The success of the check.
Item (index number)
Returns the SParameterData at the given index.
Input Parameters
index(number)
The index of the SParameterData.
Return
SParameterData
The SParameterData at the given index.
Item (label string)
Returns the SParameterData with the given label.
Input Parameters
label(string)
The label of the SParameterData.
Return
SParameterData
The SParameterData with the given label.
Items ()
Returns a table of SParameterData.
Return
List of SParameterData
A table of SParameterData.
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 SParameterData.