NearFieldCollection

A collection of near field results.

Example

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

nearFieldCollection = app.Models[1].Configurations[1].NearFields

    -- Add the first near field to a Cartesian graph 
    
graph = app.CartesianGraphs:Add()
nearFieldTrace1 = graph.Traces:Add(nearFieldCollection[1]) -- Index method
nearFieldTrace2 = graph.Traces:Add(nearFieldCollection["NearFields"]) -- Name method

    -- Add all the near fields in the collection to the 3D view

for index, nearFieldData in pairs(nearFieldCollection) do
    nearFieldPlot = app.Views[1].Plots:Add(nearFieldData)
end

Usage locations

The NearFieldCollection object can be accessed from the following locations:

Property List

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

Property Details

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