SpiceProbeCollection

A collection of SPICE probe results.

Example

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

    -- Obtain the collection of SPICE probes in the model
    
spiceProbes = app.Models[1].Configurations[1].SpiceProbes

    -- Display the list of SPICE probe requests
    
print("The following SPICE probe requests are available:")
printlist(spiceProbes)

    -- Retrieve the label of each SPICE probe request
    
for i, spiceProbeData in pairs(spiceProbes) do
    label = spiceProbeData.Label
end

Usage locations

The SpiceProbeCollection object can be accessed from the following locations:

Property List

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

Property Details

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