ExcitationSmithQuantity
The Smith excitation quantity properties.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) excitationData = app.Models[1].Configurations[1].Excitations["VoltageSource"] -- Create a smith chart and add the excitation data graph = app.SmithCharts:Add() excitationTrace = graph.Traces:Add(excitationData) -- Configure the trace quantity excitationTrace.Quantity.PhaseAdditionEnabled = true excitationTrace.Quantity.Phase = 50 excitationTrace.Quantity.LoadSubtractionEnabled = true excitationTrace.Quantity.LoadSubtractionType = pf.Enums.LoadingTypeEnum.Admittance excitationTrace.Quantity.LoadExpression = "50"
Usage locations
The ExcitationSmithQuantity object can be accessed from the following locations:
- Properties
- ExcitationSmithTrace object has property Quantity.
Property List
- LoadExpression
- The load value to use. The value is a complex expression, e.g. “50+j*0”. (Read/Write Expression)
- LoadSubtractionEnabled
- Specifies whether the loading value must be subtracted before plotting. (Read/Write boolean)
- LoadSubtractionType
- The type of load subtraction to be plotted, specified by the LoadingTypeEnum, e.g. Impedance or Admittance. (Read/Write LoadingTypeEnum)
- Phase
- The phase to be added to the trace. The value is in degrees [-360,360]. (Read/Write number)
- PhaseAdditionEnabled
- Enable phase addition for the trace. (Read/Write boolean)
- ReferenceImpedanceExpression
- The reference impedance value to use. The value is a complex expression, e.g. “50+j*0”. (Read/Write Expression)
- Type
- The type of quantity to be plotted, specified by the ImpedanceQuantityTypeEnum, e.g. Impedance, Admittance, Voltage, Current, etc. (Read/Write ImpedanceQuantityTypeEnum)
- UseCustomReferenceImpedance
- Specifies whether a custom reference impedance should be used. (Read/Write boolean)
Property Details
- LoadExpression
- The load value to use. The value is a complex expression, e.g. “50+j*0”.
- Type
- Expression
- Access
- Read/Write
- LoadSubtractionEnabled
- Specifies whether the loading value must be subtracted before plotting.
- Type
- boolean
- Access
- Read/Write
- LoadSubtractionType
- The type of load subtraction to be plotted, specified by the LoadingTypeEnum, e.g. Impedance or Admittance.
- Type
- LoadingTypeEnum
- Access
- Read/Write
- Phase
- The phase to be added to the trace. The value is in degrees [-360,360].
- Type
- number
- Access
- Read/Write
- PhaseAdditionEnabled
- Enable phase addition for the trace.
- Type
- boolean
- Access
- Read/Write
- ReferenceImpedanceExpression
- The reference impedance value to use. The value is a complex expression, e.g. “50+j*0”.
- Type
- Expression
- Access
- Read/Write
- Type
- The type of quantity to be plotted, specified by the ImpedanceQuantityTypeEnum, e.g. Impedance, Admittance, Voltage, Current, etc.
- Type
- ImpedanceQuantityTypeEnum
- Access
- Read/Write
- UseCustomReferenceImpedance
- Specifies whether a custom reference impedance should be used.
- Type
- boolean
- Access
- Read/Write