LoadQuantity

The load quantity properties.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]])
loadData = app.Models[1].Configurations[1].Loads[1]

    -- Create a cartesian graph and the load data
    
cartesianGraph = app.CartesianGraphs:Add()
loadTrace = cartesianGraph.Traces:Add(loadData)

    -- Configure the trace quantity
    
loadTrace.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current
loadTrace.Quantity.ComplexComponent = pf.Enums.ComplexComponentEnum.Phase
loadTrace.Quantity.PhaseUnwrapped = true

Usage locations

The LoadQuantity object can be accessed from the following locations:

Property List

ComplexComponent
The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum)
PhaseUnwrapped
Specifies whether the phase is unwrapped before plotting. This property is only valid when the ComplexComponent is Phase. (Read/Write boolean)
Type
The type of quantity to be plotted, specified by the NetworkQuantityTypeEnum, e.g. Impedance, Voltage, Current, etc. (Read/Write NetworkQuantityTypeEnum)
ValuesNormalised
Specifies whether the quantity values must be normalised to the range [0,1] before plotting. This property can be used together with dB scaling. This property is not valid when the ComplexComponent is Phase. (Read/Write boolean)
ValuesScaledToDB
Specifies whether the quantity values are scaled to dB before plotting. This property is only valid when the ComplexComponent is Magnitude. (Read/Write boolean)

Property Details

ComplexComponent
The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Phase, Real, Imaginary.
Type
ComplexComponentEnum
Access
Read/Write
PhaseUnwrapped
Specifies whether the phase is unwrapped before plotting. This property is only valid when the ComplexComponent is Phase.
Type
boolean
Access
Read/Write
Type
The type of quantity to be plotted, specified by the NetworkQuantityTypeEnum, e.g. Impedance, Voltage, Current, etc.
Type
NetworkQuantityTypeEnum
Access
Read/Write
ValuesNormalised
Specifies whether the quantity values must be normalised to the range [0,1] before plotting. This property can be used together with dB scaling. This property is not valid when the ComplexComponent is Phase.
Type
boolean
Access
Read/Write
ValuesScaledToDB
Specifies whether the quantity values are scaled to dB before plotting. This property is only valid when the ComplexComponent is Magnitude.
Type
boolean
Access
Read/Write