ExcitationCollection
A collection of excitation results.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) excitationCollection = app.Models[1].Configurations[1].Excitations -- Add the first excitation to a Cartesian graph graph = app.CartesianGraphs:Add() excitationTrace1 = graph.Traces:Add(excitationCollection[1]) -- Index method excitationTrace2 = graph.Traces:Add(excitationCollection["VoltageSource"]) -- Name method -- Add all the excitations in the collection to the graph for index, excitationData in pairs(excitationCollection) do excitationTrace = graph.Traces:Add(excitationData) end
Usage locations
The ExcitationCollection object can be accessed from the following locations:
- Collection lists
- SolutionConfiguration object has collection Excitations.
Property List
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 ExcitationData at the given index. (Returns a ExcitationData object.)
- Item (label string)
- Returns the ExcitationData with the given label. (Returns a ExcitationData object.)
- Items ()
- Returns a table of ExcitationData. (Returns a List of ExcitationData 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 ExcitationData at the given index in the collection. (Read ExcitationData)
- [string]
- Returns the ExcitationData with the given name in the collection. (Read ExcitationData)
Property Details
Method Details
- Contains (label string)
- Checks if the collection contains an item with the given label.
- Item (index number)
- Returns the ExcitationData at the given index.
- Input Parameters
- index(number)
- The index of the ExcitationData.
- Return
- ExcitationData
- The ExcitationData at the given index.
- Item (label string)
- Returns the ExcitationData with the given label.
- Input Parameters
- label(string)
- The label of the ExcitationData.
- Return
- ExcitationData
- The ExcitationData with the given label.
- Items ()
- Returns a table of ExcitationData.
- Return
- List of ExcitationData
- A table of ExcitationData.
- 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.