SurfaceCurrentsAndChargesStoredData

Stored surface currents and charges results.

Example

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

    -- Retrieve the 'SurfaceCurrentsData' called 'Currents1'

surfaceCurrentsData = app.Models[1].Configurations[1].SurfaceCurrents["Currents1"]

    -- Create a stored surface currents and charges data entity
    
storedData = surfaceCurrentsData:StoreData()

    -- Plot surface currents data
    
surfaceCurrentsPlot = app.Views[1].Plots:Add(storedData)

Inheritance

The SurfaceCurrentsAndChargesStoredData object is derived from the ResultData object.

Property List

Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Method List

Delete ()
Delete the stored data.
GetDataSet ()
Returns a data set containing the near field values. (Returns a DataSet object.)
GetDataSet (samplePoints number)
Returns a data set containing the near field values. (Returns a DataSet object.)
GetDataSet (startFrequency number, endFrequency number, samplePoints number)
Returns a data set containing the near field values. (Returns a DataSet object.)

Property Details

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.
GetDataSet ()
Returns a data set containing the near field values.
Return
DataSet
The data set containing the near field values.
GetDataSet (samplePoints number)
Returns a data set containing the near field values.
Input Parameters
samplePoints(number)
The number of sample points used to sample the continuous frequency axis.
Return
DataSet
The data set containing the near field values.
GetDataSet (startFrequency number, endFrequency number, samplePoints number)
Returns a data set containing the near field values.
Input Parameters
startFrequency(number)
The start frequency used to sample the continuous frequency axis.
endFrequency(number)
The end frequency used to sample the continuous frequency axis.
samplePoints(number)
The number of sample points used to sample the continuous frequency axis.
Return
DataSet
The data set containing the near field values.