CharacteristicModeQuantity

The characteristic mode quantity properties.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CharacteristicModes.fek]])   
graph = app.CartesianGraphs:Add() 
charModeTrace = graph.Traces:Add( app.Models[1].Configurations[1].CharacteristicModes[1]) 

    -- Adjust 'CharacteristicModeQuantity' of the trace 

charModeTrace.Quantity.Type = pf.Enums.CharacteristicModeQuantityTypeEnum.ModalSignificance

Usage locations (object properties)

The following objects have properties using the CharacteristicModeQuantity object:

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 CharacteristicModeQuantityTypeEnum, e.g. EigenValue, ModalSignificance, etc. (Read/Write CharacteristicModeQuantityTypeEnum)
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)

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 CharacteristicModeQuantityTypeEnum, e.g. EigenValue, ModalSignificance, etc.
Type
CharacteristicModeQuantityTypeEnum
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