RayCollection

A collection of ray results.

Example

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

RayCollection = app.Models[1].Configurations[1].Rays

    -- Add the first ray to the 3D view
    
RayTrace1 = app.Views[1].Plots:Add(RayCollection[1]) -- Index method
RayTrace2 = app.Views[1].Plots:Add(RayCollection["Rays1"]) -- Name method

    -- Add all the ray in the collection to the 3D view

for index, RayData in pairs(RayCollection) do
    RayPlot = app.Views[1].Plots:Add(RayData)
end

Usage locations (collections)

The following objects contain the RayCollection collection:

Property List

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

Property Details

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