ErrorEstimateCollection

A collection of error estimates.

Example

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

errorEstimatesCollection = app.Models[1].Configurations[1].ErrorEstimates

    -- Access the error estimates
    
errorEstimate1 = errorEstimatesCollection[1] -- Index method
errorEstimate2 = errorEstimatesCollection["ErrorEstimation1"] -- Name method

Usage locations

The ErrorEstimateCollection object can be accessed from the following locations:

Property List

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

Property Details

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