PrimitiveInstanceCollection

class ansys.edb.core.primitive.primitive_instance_collection.PrimitiveInstanceCollection(msg)

Efficiently represents large quantities of geometry as numerous instantiations of the same geometry at different locations.

Methods

PrimitiveInstanceCollection.add_void(hole)	Add a void to the primitive.
PrimitiveInstanceCollection.cast()	Cast the primitive object to the correct concrete type.
PrimitiveInstanceCollection.create(layout, ...)	Create a primitive instance collection containing the specified geometry instantiated at the provided locations.
PrimitiveInstanceCollection.create_3d_comp()	Create a 3D composite model from an MCAD file.
PrimitiveInstanceCollection.create_hfss()	Create an HFSS model from an MCAD file.
PrimitiveInstanceCollection.create_stride()	Create a Stride model from an MCAD file.
PrimitiveInstanceCollection.decompose()	Decompose into individual primitives.
PrimitiveInstanceCollection.delete()	Delete the layout object.
PrimitiveInstanceCollection.find_by_id(...)	Find a Connectable object by database ID in a given layout.
PrimitiveInstanceCollection.get_hfss_prop()	Get HFSS properties.
PrimitiveInstanceCollection.get_product_property(...)	Get the product property of the layout object for a given product ID and attribute ID.
PrimitiveInstanceCollection.get_product_property_ids(prod_id)	Get a list of attribute IDs given a product ID for the layout object.
PrimitiveInstanceCollection.make_zone_primitive(zone_id)	Make the primitive a zone primitive with a zone specified by the provided ID.
PrimitiveInstanceCollection.remove_hfss_prop()	Remove HFSS properties.
PrimitiveInstanceCollection.set_hfss_prop(...)	Set HFSS properties.
PrimitiveInstanceCollection.set_product_property(...)	Set the product property of the layout object for a given product ID and attribute ID.

Attributes

PrimitiveInstanceCollection.can_be_zone_primitive	bool: Flag indicating if the primitive can be a zone.
PrimitiveInstanceCollection.component	ComponentGroup: Component of the Connectable object.
PrimitiveInstanceCollection.edb_uid	int: Unique, persistent ID for the Connectable object.
PrimitiveInstanceCollection.geometry	PolygonData: The geometry that the primitive instance collection instantiates.
PrimitiveInstanceCollection.group	Group object.
PrimitiveInstanceCollection.has_voids	bool: Flag indicating if a primitive has voids inside.
PrimitiveInstanceCollection.id	int: Unique ID of the EDB object.
PrimitiveInstanceCollection.instantiated_geometry	list of PolygonData: The geometry instantiated at each location in the primitive instance collection.
PrimitiveInstanceCollection.is_mcad	bool: Flag indicating if this is an MCAD model.
PrimitiveInstanceCollection.is_mcad_3d_comp	bool: Flag indicating if this is a 3D composite MCAD model.
PrimitiveInstanceCollection.is_mcad_hfss	bool: Flag indicating if this is an HFSS MCAD model.
PrimitiveInstanceCollection.is_mcad_stride	bool: Flag indicating if this is a Stride MCAD model.
PrimitiveInstanceCollection.is_negative	bool: Flag indicating if the primitive is negative.
PrimitiveInstanceCollection.is_null	bool: Flag indicating if the object exists in the database.
PrimitiveInstanceCollection.is_parameterized	bool: Whether the primitive is parametrized.
PrimitiveInstanceCollection.is_void	bool: Flag indicating if a primitive is a void.
PrimitiveInstanceCollection.is_zone_primitive	bool: Flag indicating if the primitive object is a zone.
PrimitiveInstanceCollection.layer	Layer: Layer that the primitive object is on.
PrimitiveInstanceCollection.layout	Layout: Layout owning the object.
PrimitiveInstanceCollection.layout_obj_type	LayoutObjType: Layout object type of the Primitive class.
PrimitiveInstanceCollection.msg	EDBObjMessage: Protobuf message that represents the object's ID.
PrimitiveInstanceCollection.net	Net: Net of the Connectable object.
PrimitiveInstanceCollection.obj_type	LayoutObjType: Layout object type.
PrimitiveInstanceCollection.owner	Primitive: Owner of the primitive object.
PrimitiveInstanceCollection.positions	list of PointData: The positions geometry is instantiated at.
PrimitiveInstanceCollection.primitive_type	PrimitiveType: Primitive type of the primitive.
PrimitiveInstanceCollection.voids	list of Primitive: List of void primitive objects inside the primitive.