VoltageRegulator#

class ansys.edb.core.layout.voltage_regulator.VoltageRegulator(msg)#

Represents a voltage regulator.

Methods

VoltageRegulator.add_power_module(power_module)

Add a power module to the voltage regulator.

VoltageRegulator.add_power_modules(power_modules)

Add multiple power modules to the voltage regulator.

VoltageRegulator.create(layout, name, ...)

Create a voltage regulator.

VoltageRegulator.create_3d_comp()

Create a 3D composite model from an MCAD file.

VoltageRegulator.create_hfss()

Create an HFSS model from an MCAD file.

VoltageRegulator.create_stride()

Create a Stride model from an MCAD file.

VoltageRegulator.delete()

Delete the layout object.

VoltageRegulator.find_by_id(layout, uid)

Find a Connectable object by database ID in a given layout.

VoltageRegulator.get_all_power_modules()

Get all power modules in the voltage regulator.

VoltageRegulator.get_power_module(...)

Get the power module for a given component group name.

VoltageRegulator.get_product_property(...)

Get the product property of the layout object for a given product ID and attribute ID.

VoltageRegulator.get_product_property_ids(prod_id)

Get a list of attribute IDs given a product ID for the layout object.

VoltageRegulator.remove_all_power_modules()

Remove all power modules in the voltage regulator.

VoltageRegulator.remove_power_module(name)

Remove a power module from the voltage regulator.

VoltageRegulator.remove_power_modules(names)

Remove multiple power modules from the voltage regulator.

VoltageRegulator.set_product_property(...)

Set the product property of the layout object for a given product ID and attribute ID.

Attributes

VoltageRegulator.active

bool: Flag indicating if the voltage regular is active.

VoltageRegulator.component

ComponentGroup: Component of the Connectable object.

VoltageRegulator.edb_uid

int: Unique, persistent ID for the Connectable object.

VoltageRegulator.group

Group object.

VoltageRegulator.id

int: Unique ID of the EDB object.

VoltageRegulator.is_mcad

bool: Flag indicating if this is an MCAD model.

VoltageRegulator.is_mcad_3d_comp

bool: Flag indicating if this is a 3D composite MCAD model.

VoltageRegulator.is_mcad_hfss

bool: Flag indicating if this is an HFSS MCAD model.

VoltageRegulator.is_mcad_stride

bool: Flag indicating if this is a Stride MCAD model.

VoltageRegulator.is_null

bool: Flag indicating if the object exists in the database.

VoltageRegulator.layout

Layout: Layout owning the object.

VoltageRegulator.layout_obj_type

VoltageRegulator.lrc

Value: Load regulation current of the voltage regulator.

VoltageRegulator.lrp

Value: Load regulation percent of the voltage regulator.

VoltageRegulator.msg

EDBObjMessage: Protobuf message that represents the object's ID.

VoltageRegulator.name

str: Name of the voltage regulator.

VoltageRegulator.neg_remote_sense_pin

PadstackInstance: Negative remote sense pin of the voltage regulator.

VoltageRegulator.net

Net: Net of the Connectable object.

VoltageRegulator.num_active_power_modules

obj:

int: Number of active power modules.

VoltageRegulator.num_power_modules

obj:

int: Number of power modules.

VoltageRegulator.obj_type

LayoutObjType: Layout object type.

VoltageRegulator.pos_remote_sense_pin

PadstackInstance: Positive remote sense pin of the voltage regulator.

VoltageRegulator.voltage

Value: Voltage of the voltage regulator.