LoadCollection

A collection of load results.

Example

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

loadCollection = app.Models[1].Configurations[1].Loads

    -- Add the first load to a Cartesian graph 
    
graph = app.CartesianGraphs:Add()
loadTrace1 = graph.Traces:Add(loadCollection[1]) -- Index method
loadTrace2 = graph.Traces:Add(loadCollection["ComplexLoad"]) -- Name method

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

for index, loadData in pairs(loadCollection) do
    loadTrace = graph.Traces:Add(loadData)
end

Usage locations

The LoadCollection object can be accessed from the following locations:

Property List

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

Property Details

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