PlanarSubstrateCollection

A collection of planar substrate layers.

Example

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

dielectric = project.Media:AddDielectric()

project.GroundPlane.DefinitionMethod = 
    cf.Enums.GroundPlaneDefinitionMethodEnum.MultilayerSubstrate
groundPlaneLayers = project.GroundPlane.Layers

    -- Use the planar substrate collection to modify, add and remove ground plane layers
    
groundPlaneLayers:Add(2, cf.Enums.GroundBottomTypeEnum.None, 0.1, dielectric)
groundPlaneLayers:Modify(2, cf.Enums.GroundBottomTypeEnum.None, 0.5, dielectric)
groundPlaneLayers:Remove(3)

Usage locations (collections)

The following objects contain the PlanarSubstrateCollection collection:

Property List

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

Method List

Add (index number, ground GroundBottomTypeEnum, thickness Expression, medium Medium)
Add a ground layer to the planar multilayer substrate at the given index. The ground layer will always be added in between the top and bottom layers.The ground layer index numbering starts at “1”.
Item (index number)
Returns the PlanarSubstrate at the given index.The ground layer index numbering starts at “1”. (Returns a PlanarSubstrate object.)
Modify (index number, ground GroundBottomTypeEnum, thickness Expression, medium Medium)
Modify the ground layer at the given index. The ground layer index numbering starts at “1”.
Remove (index number)
Remove the ground layer at the given index. The ground layer index numbering starts at “1”.

Index List

[number]
Returns the PlanarSubstrate at the given index in the collection.The ground layer index numbering starts at “1”. (Read PlanarSubstrate)

Property Details

Count
The number of PlanarSubstrate items in the collection.
Type
number
Access
Read only

Method Details

Add (index number, ground GroundBottomTypeEnum, thickness Expression, medium Medium)
Add a ground layer to the planar multilayer substrate at the given index. The ground layer will always be added in between the top and bottom layers.The ground layer index numbering starts at “1”.
Input Parameters
index(number)
The layer index. The ground layer index numbering starts at “1”.
ground(GroundBottomTypeEnum)
The planar substrate ground plane type.
thickness(Expression)
The planar substrate thickness.
medium(Medium)
The planar substrate medium.
Item (index number)
Returns the PlanarSubstrate at the given index.The ground layer index numbering starts at “1”.
Input Parameters
index(number)
The index of the PlanarSubstrate.The ground layer index numbering starts at “1”.
Return
PlanarSubstrate
The PlanarSubstrate at the given indexThe ground layer index numbering starts at “1”.
Modify (index number, ground GroundBottomTypeEnum, thickness Expression, medium Medium)
Modify the ground layer at the given index. The ground layer index numbering starts at “1”.
Input Parameters
index(number)
The layer index. The ground layer index numbering starts at “1”.
ground(GroundBottomTypeEnum)
The planar substrate ground plane type.
thickness(Expression)
The planar substrate thickness.
medium(Medium)
The planar substrate medium.
Remove (index number)
Remove the ground layer at the given index. The ground layer index numbering starts at “1”.
Input Parameters
index(number)
The layer index. The ground layer index numbering starts at “1”.