ReceivingAntennaCollection

A collection of receiving antenna results.

Example

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

receivingAntennaCollection = app.Models[1].Configurations[1].ReceivingAntennas

    -- Add the first receiving antenna request to a Cartesian graph 
    
graph = app.CartesianGraphs:Add()

    -- Index method

receivingAntennaTrace1 = graph.Traces:Add(receivingAntennaCollection[1])
  
    -- Name method

receivingAntennaTrace2 = graph.Traces:Add(receivingAntennaCollection["FarFieldReceivingAntenna1"])

Usage locations

The ReceivingAntennaCollection object can be accessed from the following locations:

Property List

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

Property Details

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