`CustomStoredData`

Stored custom data.

Example

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

    -- Retrieve the 'CustomStoredData' called 'CustomData'
    
customData = app.StoredData["CustomData"]
graph = app.CartesianGraphs:Add()
customDataTrace = graph.Traces:Add(customData)

    -- Store a copy of the custom data
    
storedData = customData:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.Custom)

Inheritance

The CustomStoredData object is derived from the ResultData object.

Property List

ContinuousFrequencyAxis: Continuous frequency axis exists. (Read only boolean)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

Delete (): Delete the stored data.
ExportData (filename string): Export the custom data to the specified tab-separated file.
GetDataSet (): Returns a data set containing the custom data values. (Returns a DataSet object.)

Property Details

ContinuousFrequencyAxis

Continuous frequency axis exists.

Type: boolean
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

Delete ()

Delete the stored data.

ExportData (filename string)

Export the custom data to the specified tab-separated file.

Input Parameters

filename(string): The name of the exported data file without its extension.

GetDataSet ()

Returns a data set containing the custom data values.

Return

DataSet: The data set containing the custom data values.