ReciprocalExcitationCollection

A collection of reciprocity data results.

Example

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

    -- The 'ReciprocalExcitations' is a collection of reciprocity data

reciprocalExcitationCollection = app.Models[1].Configurations[1].ReciprocalExcitations

    -- Output the number of reciprocity data.

print("Number of elements in the reciprocity data collection: " .. #reciprocalExcitationCollection)

Inheritance

The ReciprocalExcitationCollection object is derived from the object.

Usage locations

The ReciprocalExcitationCollection object can be accessed from the following locations:

Property List

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

Property Details

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