StoredDataCollection

A collection of stored data results.

Example

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

    -- Display the list of stored data entities
    
print("The following stored data entities are available:")
printlist(app.StoredData)

    -- Obtain the collection of stored data in the model
    
storedData = app.StoredData

    -- Retrieve the label of each stored data entity
    
for i, data in pairs(storedData) do
    label = data.Label
end

Usage locations

The StoredDataCollection object can be accessed from the following locations:

Property List

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

Property Details

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