SARCollection

A collection of SAR results.

Example

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

SARCollection = app.Models[1].Configurations[1].SAR

    -- Add the first SAR request to a Cartesian graph 
    
graph = app.CartesianGraphs:Add()
SARTrace1 = graph.Traces:Add(SARCollection[1])      -- Index method
SARTrace2 = graph.Traces:Add(SARCollection["SAR1"]) -- Name method

    -- Add all other SAR requests in the collection to the 3D view

for index, SARData in pairs(SARCollection) do
    if (index > 1) then
        SARPlot = app.Views[1].Plots:Add(SARData)
    end
end

Usage locations

The SARCollection object can be accessed from the following locations:

Property List

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

Property Details

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