NearFieldPowerIntegralCollection
A collection of near field power integral results.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) -- Get the near field power integral collection nearFieldPowerIntegralCollection = app.Models[1].Configurations[1].NearFieldPowerIntegrals -- Add items from the collection to a graph graph = app.CartesianGraphs:Add() nearFieldPower1 = graph.Traces:Add(nearFieldPowerIntegralCollection[1]) -- Index method nearFieldPower2 = graph.Traces:Add(nearFieldPowerIntegralCollection["NearFields"]) -- Name method
Usage locations
The NearFieldPowerIntegralCollection object can be accessed from the following locations:
- Collection lists
- SolutionConfiguration object has collection NearFieldPowerIntegrals.
Property List
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 NearFieldPowerIntegralData at the given index. (Returns a NearFieldPowerIntegralData object.)
- Item (label string)
- Returns the NearFieldPowerIntegralData with the given label. (Returns a NearFieldPowerIntegralData object.)
- Items ()
- Returns a table of NearFieldPowerIntegralData. (Returns a List of NearFieldPowerIntegralData 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 NearFieldPowerIntegralData at the given index in the collection. (Read NearFieldPowerIntegralData)
- [string]
- Returns the NearFieldPowerIntegralData with the given name in the collection. (Read NearFieldPowerIntegralData)
Property Details
Method Details
- Contains (label string)
- Checks if the collection contains an item with the given label.
- Item (index number)
- Returns the NearFieldPowerIntegralData at the given index.
- Input Parameters
- index(number)
- The index of the NearFieldPowerIntegralData.
- Return
- NearFieldPowerIntegralData
- The NearFieldPowerIntegralData at the given index.
- Item (label string)
- Returns the NearFieldPowerIntegralData with the given label.
- Input Parameters
- label(string)
- The label of the NearFieldPowerIntegralData.
- Return
- NearFieldPowerIntegralData
- The NearFieldPowerIntegralData with the given label.
- Items ()
- Returns a table of NearFieldPowerIntegralData.
- Return
- List of NearFieldPowerIntegralData
- A table of NearFieldPowerIntegralData.
- 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.