ImportedDataSetCollection

A collection of imported data sets.

Example

app = pf.GetApplication()
app:NewProject()
graph = app.CartesianGraphs:Add()

app:ImportResults(FEKO_HOME..[[/shared/Resources/Automation/SParameters.s2p]],
                              pf.Enums.ImportFileTypeEnum.Touchstone)

    -- Retrieve the newly imported import set from the import set collection
    
importSetCollection = app.ImportedDataSets
numberOfImportSets = importSetCollection.Count

    -- Retrieve the label and source file of the first import set

label = importSetCollection[1].Label
sourceFile = importSetCollection[1].SourceFile

    -- Duplicate the newly imported import set and then delete the original
    
importSetCopy = importSetCollection[1]:Duplicate()
importSetCollection[1]:Delete()

    -- Add the first imported data in the copied import set to the cartesian graph
    
graph.Traces:Add(importSetCopy.ImportedData[1])

Usage locations

The ImportedDataSetCollection object can be accessed from the following locations:

Property List

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

Property Details

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