WireCurrentsMathScript

Wire currents math script data that can be plotted.

Example

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

    -- Create a currents math script
    
currentsMathScript = app.MathScripts:Add(pf.Enums.MathScriptTypeEnum.WireCurrentsAndCharges)
script = 
[[
dataSet = pf.WireCurrentsAndCharges.GetDataSet("Dipole_example.StandardConfiguration1.Currents1")
scale = 2
currentsMatrix = dataSet:ToComplexMatrix({"Current"})
currentsMatrix = currentsMatrix * scale
dataSet:FromComplexMatrix(currentsMatrix, {"Current"})
return dataSet
]]
currentsMathScript.Script = script
currentsMathScript:Run()

    -- Plot the math script

currentsPlot = app.Views[1].Plots:Add(currentsMathScript)

Inheritance

The WireCurrentsMathScript object is derived from the MathScript object.

Property List

DataSetAvailable
Valid result data exist. (Read only boolean)
Label
The object label. (Read/Write string)
Script
The script code to execute. (Read/Write string)
Type
The object type string. (Read only string)

Method List

Delete ()
Delete the math script.
Duplicate ()
Duplicate the math script. (Returns a MathScript object.)
GetDataSet ()
Returns a data set containing the math script values. (Returns a DataSet object.)
Run ()
Run the math script.
StoreData ()
Creates a local stored version of the result data. (Returns a ResultData object.)

Property Details

DataSetAvailable
Valid result data exist.
Type
boolean
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
Script
The script code to execute.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

Delete ()
Delete the math script.
Duplicate ()
Duplicate the math script.
Return
MathScript
The duplicated math script.
GetDataSet ()
Returns a data set containing the math script values.
Return
DataSet
The data set containing the math script values.
Run ()
Run the math script.
StoreData ()
Creates a local stored version of the result data.
Return
ResultData
The new stored data.