NetworkCollection

A collection of network results.

Example

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

networkCollection = app.Models[1].Configurations[1].Networks

    -- Add the first network to a Cartesian graph 
    
graph = app.CartesianGraphs:Add()
networkTrace1 = graph.Traces:Add(networkCollection[1]) -- Index method
networkTrace2 = graph.Traces:Add(networkCollection["MatchingNetwork"]) -- Name method

    -- Add all the networks in the collection to the graph

for index, networkData in pairs(networkCollection) do
    networkTrace = graph.Traces:Add(networkData)
end

Usage locations

The NetworkCollection object can be accessed from the following locations:

Property List

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

Property Details

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