CharacteristicModeCollection

A collection of characteristic mode results.

Example

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

characteristicModeCollection = app.Models[1].Configurations[1].CharacteristicModes

    -- Add the first characteristic modes to a Cartesian graph 
    
graph = app.CartesianGraphs:Add()


    -- Index method

characteristicModeTrace1 = graph.Traces:Add(characteristicModeCollection[1]) 

    -- Name method

characteristicModeTrace1 = graph.Traces:Add(characteristicModeCollection["CharacteristicModes1"])

Usage locations

The CharacteristicModeCollection object can be accessed from the following locations:

Property List

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

Property Details

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