XmlMaterials#

class pyedb.xml_parser.xml_stackup.XmlMaterials(/, **data: Any)#

Bases: pydantic.BaseModel

Container for material definitions in the XML stackup.

Parameters:
materiallist of XmlMaterial, optional

List of material definitions. The default is an empty list.

Overview#

add_material

Add a material to the stackup.

material

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Import detail#

from pyedb.xml_parser.xml_stackup import XmlMaterials

Attribute detail#

XmlMaterials.material: list[XmlMaterial] | None = None#
XmlMaterials.model_config#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Method detail#

XmlMaterials.add_material(name: str, **kwargs) → XmlMaterial#

Add a material to the stackup.

Parameters:
namestr

Name of the material.

**kwargsfloat

Material properties as keyword arguments. Supported properties include permittivity, permeability, conductivity, dielectric_loss_tangent, and magnetic_loss_tangent.

Returns:
XmlMaterial

The newly created material object.

Examples

>>> from pyedb.xml_parser.xml_stackup import XmlMaterials
>>> materials = XmlMaterials()
>>> copper = materials.add_material("copper", conductivity=5.8e7)
>>> fr4 = materials.add_material("fr4", permittivity=4.5, dielectric_loss_tangent=0.02)