ComponentGroup#

class ansys.edb.core.hierarchy.component_group.ComponentGroup(msg)#

Represents a component group object.

Methods

ComponentGroup.add_member(member)

Add an object to the group.

ComponentGroup.cast()

Cast the group object to the correct concrete type.

ComponentGroup.create(layout, name, comp_name)

Create a component group with a component.

ComponentGroup.create_3d_comp()

Create a 3D composite model from an MCAD file.

ComponentGroup.create_hfss()

Create an HFSS model from an MCAD file.

ComponentGroup.create_stride()

Create a Stride model from an MCAD file.

ComponentGroup.delete()

Delete the layout object.

ComponentGroup.find(layout, name)

Find a group by name.

ComponentGroup.find_by_def(layout, comp_def_name)

Find all components belonging to a given component definition.

ComponentGroup.find_by_id(layout, uid)

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

ComponentGroup.get_product_property(prod_id, ...)

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

ComponentGroup.get_product_property_ids(prod_id)

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

ComponentGroup.remove_member(member)

Remove an object from the group.

ComponentGroup.set_product_property(prod_id, ...)

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

ComponentGroup.ungroup(recursive)

Dissolve the group.

Attributes

ComponentGroup.component

ComponentGroup: Component of the Connectable object.

ComponentGroup.component_def

ComponentDef: Component definition for the hierarchy object if it exists, None otherwise.

ComponentGroup.component_property

ComponentProperty: Component property of the component group.

ComponentGroup.component_type

ComponentType: Component type of the component group.

ComponentGroup.edb_uid

int: Unique, persistent ID for the Connectable object.

ComponentGroup.group

Group object.

ComponentGroup.id

int: Unique ID of the EDB object.

ComponentGroup.is_mcad

bool: Flag indicating if this is an MCAD model.

ComponentGroup.is_mcad_3d_comp

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

ComponentGroup.is_mcad_hfss

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

ComponentGroup.is_mcad_stride

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

ComponentGroup.is_null

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

ComponentGroup.layout

Layout: Layout owning the object.

ComponentGroup.layout_obj_type

ComponentGroup.location

tuple (Value, Value): Location [x, y] of the hierarchy object on the placement_layer object.

ComponentGroup.members

list of Connectables: All group members.

ComponentGroup.msg

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

ComponentGroup.name

str: Name of the hierarchy object.

ComponentGroup.net

Net: Net of the Connectable object.

ComponentGroup.num_pins

int: Number of pins in the component group.

ComponentGroup.obj_type

LayoutObjType: Layout object type.

ComponentGroup.placement_layer

Layer: Placement layer for the hierarchy object.

ComponentGroup.solve_independent_preference

bool: Flag indicating if the object is assigned to solve independent of its parent context.

ComponentGroup.transform

Transform: Transformation information of the hierarchy object.