Result3DPlotCollection
A collection of results available for the 3D view.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) -- Get the plots collection for the first 3D View plots = app.Views[1].Plots -- Add far field, near field and surface current 3D plots plots:Add(app.Models[1].Configurations[1].FarFields[1]) plots:Add(app.Models[1].Configurations[1].NearFields[1]) plots:Add(app.Models[1].Configurations[1].SurfaceCurrents[1]) -- SetProperties the label of each of the plots in the collection for plotNum, plot in pairs(plots) do plot.Label = "3D_Plot_" .. plotNum end -- Print the list of all the plots in the collection printlist(plots)
Usage locations (collections)
The following objects contain the Result3DPlotCollection collection:
Property List
Method List
- Add (result ResultData)
- Adds a result to a view. (Returns a ResultPlot object.)
- Contains (label string)
- Checks if the collection contains an item with the given label. (Returns a boolean object.)
- Item (index number)
- Returns the Result3DPlot at the given index. (Returns a Result3DPlot object.)
- Item (label string)
- Returns the Result3DPlot with the given label. (Returns a Result3DPlot object.)
- Items ()
- Returns a table of Result3DPlot. (Returns a List of Result3DPlot 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 Result3DPlot at the given index in the collection. (Read Result3DPlot)
- [string]
- Returns the Result3DPlot with the given name in the collection. (Read Result3DPlot)
Property Details
Method Details
- Add (result ResultData)
- Adds a result to a view.
- Input Parameters
- result(ResultData)
- The result to add to the view.
- Return
- ResultPlot
- The 3D result of the plot on the graph.
- Contains (label string)
- Checks if the collection contains an item with the given label.
- Item (index number)
- Returns the Result3DPlot at the given index.
- Input Parameters
- index(number)
- The index of the Result3DPlot.
- Return
- Result3DPlot
- The Result3DPlot at the given index.
- Item (label string)
- Returns the Result3DPlot with the given label.
- Input Parameters
- label(string)
- The label of the Result3DPlot.
- Return
- Result3DPlot
- The Result3DPlot with the given label.
- Items ()
- Returns a table of Result3DPlot.
- Return
- List of Result3DPlot
- A table of Result3DPlot.
- 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.