ResultSurfacePlotCollection

A collection of surface plots.

Example

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

    -- Get the plots collection for the first Cartesian surface graph
    
plots = app.CartesianSurfaceGraphs[1].Plots

    -- Add a far field surface plot to the collection
    
plots:Add(app.Models[1].Configurations[1].FarFields[1])

    -- SetProperties the label of each of the plots in the collection

for plotNum, plot in pairs(plots) do
    plot.Label = "Surface_Plot_" .. plotNum
end

    -- Print the list of all the plots in the collection

printlist(plots)

Inheritance

The ResultSurfacePlotCollection object is derived from the object.

Usage locations

The ResultSurfacePlotCollection object can be accessed from the following locations:

Property List

Count
The number of ResultSurfacePlot items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

Add (result ResultData)
Adds a result to a graph. (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 ResultSurfacePlot at the given index. (Returns a ResultSurfacePlot object.)
Item (label string)
Returns the ResultSurfacePlot with the given label. (Returns a ResultSurfacePlot object.)
Items ()
Returns a table of ResultSurfacePlot. (Returns a List of ResultSurfacePlot 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 ResultSurfacePlot at the given index in the collection. (Read ResultSurfacePlot)
[string]
Returns the ResultSurfacePlot with the given name in the collection. (Read ResultSurfacePlot)

Property Details

Count
The number of ResultSurfacePlot items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

Add (result ResultData)
Adds a result to a graph.
Input Parameters
result(ResultData)
The result to add to the graph.
Return
ResultPlot
The plot on the graph.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the ResultSurfacePlot.
Return
boolean
The success of the check.
Item (index number)
Returns the ResultSurfacePlot at the given index.
Input Parameters
index(number)
The index of the ResultSurfacePlot.
Return
ResultSurfacePlot
The ResultSurfacePlot at the given index.
Item (label string)
Returns the ResultSurfacePlot with the given label.
Input Parameters
label(string)
The label of the ResultSurfacePlot.
Return
ResultSurfacePlot
The ResultSurfacePlot with the given label.
Items ()
Returns a table of ResultSurfacePlot.
Return
List of ResultSurfacePlot
A table of ResultSurfacePlot.
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 ResultSurfacePlot.