FarFieldPowerIntegralCollection

A collection of far field power integral results.

Example

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

farFieldPowerCollection = app.Models[1].Configurations[1].FarFieldPowerIntegrals

    -- Add the first far field power to a Cartesian graph 
    
graph = app.CartesianGraphs:Add()
farFieldTrace1 = graph.Traces:Add(farFieldPowerCollection[1]) -- Index method
farFieldTrace2 = graph.Traces:Add(farFieldPowerCollection["FarFields"]) -- Name method

    -- Add all the far fields in the collection to the Cartesian graph

for index, farFieldData in pairs(farFieldPowerCollection) do
    farFieldTrace = graph.Traces:Add(farFieldData)
end

Usage locations (collections)

The following objects contain the FarFieldPowerIntegralCollection collection:

Property List

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

Property Details

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