TraceMathExpression

The trace math expression.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])    
cartesianGraph = app.CartesianGraphs:Add()
trace = cartesianGraph.Traces:Add(app.Models[1].Configurations[1].NearFields[1])

    -- Set 'TraceMathExpression' properties

trace.Math.Expression = "self*2.0"
trace.Math.Enabled = true

Usage locations (object properties)

The following objects have properties using the TraceMathExpression object:

Property List

CommonRangeEnabled
Specifies whether the range is limited to the range common to all traces used in the expression. (Read/Write boolean)
Enabled
Specifies whether the math expression is enabled for this trace. (Read/Write boolean)
Expression
The math expression used to calculate this trace, e.g. “self*2.0”. (Read/Write string)
NoUnit
Specifies the no unit must be used for this trace. (Read/Write boolean)
UnitExpression
The unit for the values resulting from the math expression, e.g. “m/s^2”. Only applies if NoUnit is false. (Read/Write string)

Property Details

CommonRangeEnabled
Specifies whether the range is limited to the range common to all traces used in the expression.
Type
boolean
Access
Read/Write
Enabled
Specifies whether the math expression is enabled for this trace.
Type
boolean
Access
Read/Write
Expression
The math expression used to calculate this trace, e.g. “self*2.0”.
Type
string
Access
Read/Write
NoUnit
Specifies the no unit must be used for this trace.
Type
boolean
Access
Read/Write
UnitExpression
The unit for the values resulting from the math expression, e.g. “m/s^2”. Only applies if NoUnit is false.
Type
string
Access
Read/Write