`SurfaceImpedanceFrequencyCollection`

A collection of frequency points modelling the surface impedance properties.

Example

app = cf.GetApplication()
project = app:NewProject()

surfaceImpedance = project.Media:AddImpedanceSheet()

properties = surfaceImpedance:GetProperties()
properties.DefinitionMethod = cf.Enums.MediumImpedanceDefinitionMethodEnum.FrequencyList
properties.FrequencyPoints[1].Frequency = 1e3
properties.FrequencyPoints[1].ImpedanceReal = 1.0
properties.FrequencyPoints[1].ImpedanceImaginary = 0
surfaceImpedance:SetProperties(properties)

surfaceImpedanceFrequencyCollection = surfaceImpedance.FrequencyPoints

    -- Use the surface impedance frequency collection to change the frequency points

surfaceImpedanceFrequencyCollection:Modify(1, 1.5e3, 1.0, 0)
surfaceImpedanceFrequencyCollection:Add(2e3, 1.0, 0)
surfaceImpedanceFrequencyCollection:Remove(1)

Usage locations (collections)

The following objects contain the SurfaceImpedanceFrequencyCollection collection:

ImpedanceSheet(.FrequencyPoints)

Property List

Count: The number of SurfaceImpedanceFrequencyPoint items in the collection. (Read only number)

Method List

Add (frequency Expression, realimpedance Expression, imaginaryimpedance Expression): Add a frequency point of surface impedance properties to the impedance sheet.This method is only valid when the DefinitionMethod is FrequencyList.
Item (index number): Returns the SurfaceImpedanceFrequencyPoint at the given index. (Returns a SurfaceImpedanceFrequencyPoint object.)
Modify (index number, frequency Expression, realimpedance Expression, imaginaryimpedance Expression): Modify the frequency point of surface impedance properties at the given indexThis method is only valid when the DefinitionMethod is FrequencyList.
Remove (index number): Remove the frequency point of surface impedance properties at the given indexThis method is only valid when the DefinitionMethod is FrequencyList.

Index List

[number]: Returns the SurfaceImpedanceFrequencyPoint at the given index in the collection. (Read SurfaceImpedanceFrequencyPoint)

Property Details

Count

The number of SurfaceImpedanceFrequencyPoint items in the collection.

Type: number
Access: Read only

Method Details

Add (frequency Expression, realimpedance Expression, imaginaryimpedance Expression)

Add a frequency point of surface impedance properties to the impedance sheet.This method is only valid when the DefinitionMethod is FrequencyList.

Input Parameters

frequency(Expression): The frequency value (Hz).
realimpedance(Expression): The real impedance value (Ohm).
imaginaryimpedance(Expression): The imaginary impedance value (Ohm).

Item (index number)

Returns the SurfaceImpedanceFrequencyPoint at the given index.

Input Parameters

index(number): The index of the SurfaceImpedanceFrequencyPoint.

Return

SurfaceImpedanceFrequencyPoint: The SurfaceImpedanceFrequencyPoint at the given index.

Modify (index number, frequency Expression, realimpedance Expression, imaginaryimpedance Expression)

Modify the frequency point of surface impedance properties at the given indexThis method is only valid when the DefinitionMethod is FrequencyList.

Input Parameters

index(number): The frequency point index.
frequency(Expression): The frequency value (Hz).
realimpedance(Expression): The real impedance value (Ohm).
imaginaryimpedance(Expression): The imaginary impedance value (Ohm).

Remove (index number)

Remove the frequency point of surface impedance properties at the given indexThis method is only valid when the DefinitionMethod is FrequencyList.

Input Parameters

index(number): The frequency point index.