SmithChartCollection

A collection of Smith charts.

Example

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

    -- Create graphs 
    
graph1 = app.SmithCharts:Add()
graph1.Traces:Add(app.Models[1].Configurations[1].Excitations[1])
graph2 = graph1:Duplicate()

    -- Export all graphs in the 'SmithChartCollection'

for index, graph in pairs(app.SmithCharts) do    
    graph:Maximise()
    graph:ExportImage("temp_Graph"..index, "pdf")
end

Usage locations

The SmithChartCollection object can be accessed from the following locations:

Property List

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

Method List

Add ()
Adds a new Smith chart to the collection. (Returns a SmithChart object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the SmithChart at the given index. (Returns a SmithChart object.)
Item (label string)
Returns the SmithChart with the given label. (Returns a SmithChart object.)
Items ()
Returns a table of SmithChart. (Returns a List of SmithChart 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 SmithChart at the given index in the collection. (Read SmithChart)
[string]
Returns the SmithChart with the given name in the collection. (Read SmithChart)

Property Details

Count
The number of SmithChart items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

Add ()
Adds a new Smith chart to the collection.
Return
SmithChart
The new Smith chart.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the SmithChart.
Return
boolean
The success of the check.
Item (index number)
Returns the SmithChart at the given index.
Input Parameters
index(number)
The index of the SmithChart.
Return
SmithChart
The SmithChart at the given index.
Item (label string)
Returns the SmithChart with the given label.
Input Parameters
label(string)
The label of the SmithChart.
Return
SmithChart
The SmithChart with the given label.
Items ()
Returns a table of SmithChart.
Return
List of SmithChart
A table of SmithChart.
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 SmithChart.