MultiPlanar

class MultiPlanar(metadata: dict | None = None, overwrite_enabled: bool = False, enable_renderers: bool = True, layer_stack_filename: str | None = None)

Metal class for a multiple planar design, consisting of either single or multiple chips. Typically assumed to have some CPW geometries.

Inherits QDesign class.

Pass metadata to QDesign.

Parameters:

• metadata (dict, optional) – Pass to QDesign. Defaults to {}.

• overwrite_enabled (bool, optional) – Passed to QDesign base class. Defaults to False.

• enable_renderers (bool, optional) – Passed to QDesign base class. Defaults to True.

Attributes

MultiPlanar.chips	Return a Dict of information regarding chip.
MultiPlanar.metadata	Return the metadata Dict object that keeps track of all metadata in the design.
MultiPlanar.net_info	Provides a copy of net_info table which holds all the connections,
MultiPlanar.qcomponent_latest_assigned_id	Return unique number for each instance.
MultiPlanar.qgeometry	Returns the QGeometryTables (Use for advanced users only)
MultiPlanar.qnet	Returns the QNet (Use for advanced users only)
MultiPlanar.renderers	Return a Dict of all the renderers registered within QDesign.
MultiPlanar.template_options	Return default_options dictionary, which contain default options used in creating Metal component, and in calling other drawing and key functions.
MultiPlanar.template_renderer_options	Return default_renderer_options dictionary, which contain default options used in creating Metal renderer.
MultiPlanar.variables	Return the Dict object that keeps track of all variables in the design.

Methods

MultiPlanar.add_default_data_for_qgeometry_tables(...)	Populate the dict (self.renderer_defaults_by_table) which will hold the data until a component's get_template_options(design) is executed.
MultiPlanar.add_dependency(parent, child)	Add a dependency between one component and another.
MultiPlanar.all_component_names_id()	Get the text names and corresponding unique ID of each component within this design.
MultiPlanar.connect_pins(comp1_id, ...)	Will generate an unique net_id and placed in a net_info table.
MultiPlanar.copy_multiple_qcomponents(...[, ...])	The lists in the arguments are all used in parallel.
MultiPlanar.copy_qcomponent(...[, ...])	Copy a qcomponent in QDesign and add it to QDesign._components using options_overwrite.
MultiPlanar.delete_all_components()	Clear all components in the design dictionary.
MultiPlanar.delete_all_pins()	Clear all pins in the net_Info and update the pins in components.
MultiPlanar.delete_component(component_name)	Deletes component and pins attached to said component.
MultiPlanar.get_chip_layer([chip_name])	Return the chip layer number for the ground plane.
MultiPlanar.get_chip_size([chip_name])	Utility function to get a dictionary containing chip dimensions (size and center).
MultiPlanar.get_chip_z([chip_name])	Utility function to return the z value of a chip.
MultiPlanar.get_design_name()	Get the name of the design from the metadata.
MultiPlanar.get_list_of_tables_in_metadata(...)	Look at the metadata dict to get list of tables the component uses.
MultiPlanar.get_units()	Gets the units of the design.
MultiPlanar.get_x_y_for_chip(chip_name)	If the chip_name is in self.chips, along with entry for size information then return a tuple=(minx, miny, maxx, maxy).
MultiPlanar.load_design(path)	Load a Metal design from a saved Metal file.
MultiPlanar.parse_options(params, param_names)	Extra utility function that can call parse_value on individual options.
MultiPlanar.parse_value(value)	Main parsing function.
MultiPlanar.rebuild()	Remakes all components with their current parameters.
MultiPlanar.remove_dependency(parent, child)	Remove a dependency between one component and another.
MultiPlanar.rename_component(component_id, ...)	Rename component.
MultiPlanar.rename_variable(old_key, new_key)	Renames a variable in the variables dictionary.
MultiPlanar.save_design([path])	Save the metal design to a Metal file.
MultiPlanar.set_design_name(name)	Set the name of the design in the metadata.
MultiPlanar.to_python_script([thin, printout])	Generates a python script from current chip :param printout: Whether to print the script :type printout: bool
MultiPlanar.update_component(component_name)	Update the component and any dependencies it may have.
MultiPlanar.update_metadata(new_metadata)	Update the metadata dictionary of the design with a new metadata dictionary.