ModelCollection

A collection of Feko models.

Example

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

    -- Get the model count and access the 'Model'

modelCount = #app.Models
startupModel = app.Models["startup"]

Usage locations

The ModelCollection object can be accessed from the following locations:

Property List

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

Property Details

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