:class:`EdbInit` ================ .. py:class:: pyedb.grpc.edb_init.EdbInit(edbversion) Bases: :py:obj:`object` Edb Dot Net Class. .. !! processed by numpydoc !! .. py:currentmodule:: EdbInit Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~delete` - Delete a database at the specified file location. * - :py:attr:`~save` - Save any changes into a file. * - :py:attr:`~close` - Close the database. * - :py:attr:`~find_by_id` - Find a database by ID. * - :py:attr:`~save_as` - Save this Database to a new location and older EDB version. * - :py:attr:`~get_product_property` - Get the product-specific property value. * - :py:attr:`~set_product_property` - Set the product property associated with the given product and attribute ids. * - :py:attr:`~get_product_property_ids` - Get a list of attribute ids corresponding to a product property id. * - :py:attr:`~import_material_from_control_file` - Import materials from the provided control file. * - :py:attr:`~scale` - Uniformly scale all geometry and their locations by a positive factor. * - :py:attr:`~copy_cells` - Copy Cells from other Databases or this Database into this Database. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~db` - Active database object. * - :py:attr:`~top_circuit_cells` - Get top circuit cells. * - :py:attr:`~circuit_cells` - Get all circuit cells in the Database. * - :py:attr:`~footprint_cells` - Get all footprint cells in the Database. * - :py:attr:`~edb_uid` - Get ID of the database. * - :py:attr:`~is_read_only` - Determine if the database is open in a read-only mode. * - :py:attr:`~directory` - Get the directory of the Database. * - :py:attr:`~source` - Get source name for this Database. * - :py:attr:`~source_version` - Get the source version for this Database. * - :py:attr:`~apd_bondwire_defs` - Get all APD bondwire definitions in this Database. * - :py:attr:`~jedec4_bondwire_defs` - Get all JEDEC4 bondwire definitions in this Database. * - :py:attr:`~jedec5_bondwire_defs` - Get all JEDEC5 bondwire definitions in this Database. * - :py:attr:`~padstack_defs` - Get all Padstack definitions in this Database. * - :py:attr:`~package_defs` - Get all Package definitions in this Database. * - :py:attr:`~component_defs` - Get all component definitions in the database. * - :py:attr:`~material_defs` - Get all material definitions in the database. * - :py:attr:`~dataset_defs` - Get all dataset definitions in the database. .. tab-item:: Attributes .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~logger` - * - :py:attr:`~version` - * - :py:attr:`~session` - Import detail ------------- .. code-block:: python from pyedb.grpc.edb_init import EdbInit Property detail --------------- .. py:property:: db Active database object. .. !! processed by numpydoc !! .. py:property:: top_circuit_cells Get top circuit cells. :Returns: :class:`python:list`\[:class:`Cell `] .. .. !! processed by numpydoc !! .. py:property:: circuit_cells Get all circuit cells in the Database. :Returns: :class:`python:list`\[:class:`Cell `] .. .. !! processed by numpydoc !! .. py:property:: footprint_cells Get all footprint cells in the Database. :Returns: :class:`python:list`\[:class:`Cell `] .. .. !! processed by numpydoc !! .. py:property:: edb_uid Get ID of the database. :Returns: :class:`python:int` The unique EDB id of the Database. .. !! processed by numpydoc !! .. py:property:: is_read_only Determine if the database is open in a read-only mode. :Returns: :ref:`bool ` True if Database is open with read only access, otherwise False. .. !! processed by numpydoc !! .. py:property:: directory Get the directory of the Database. :Returns: :class:`python:str` Directory of the Database. .. !! processed by numpydoc !! .. py:property:: source Get source name for this Database. This attribute is also used to set the source name. :Returns: :class:`python:str` name of the source .. !! processed by numpydoc !! .. py:property:: source_version Get the source version for this Database. This attribute is also used to set the version. :Returns: :class:`python:str` version string .. !! processed by numpydoc !! .. py:property:: apd_bondwire_defs Get all APD bondwire definitions in this Database. :Returns: :class:`python:list`\[:class:`ApdBondwireDef `] .. .. !! processed by numpydoc !! .. py:property:: jedec4_bondwire_defs Get all JEDEC4 bondwire definitions in this Database. :Returns: :class:`python:list`\[:class:`Jedec4BondwireDef `] .. .. !! processed by numpydoc !! .. py:property:: jedec5_bondwire_defs Get all JEDEC5 bondwire definitions in this Database. :Returns: :class:`python:list`\[:class:`Jedec5BondwireDef `] .. .. !! processed by numpydoc !! .. py:property:: padstack_defs Get all Padstack definitions in this Database. :Returns: :class:`python:list`\[:class:`PadstackDef `] .. .. !! processed by numpydoc !! .. py:property:: package_defs Get all Package definitions in this Database. :Returns: :class:`python:list`\[:class:`PackageDef `] .. .. !! processed by numpydoc !! .. py:property:: component_defs Get all component definitions in the database. :Returns: :class:`python:list`\[:class:`ComponentDef `] .. .. !! processed by numpydoc !! .. py:property:: material_defs Get all material definitions in the database. :Returns: :class:`python:list`\[:class:`MaterialDef `] .. .. !! processed by numpydoc !! .. py:property:: dataset_defs Get all dataset definitions in the database. :Returns: :class:`python:list`\[:class:`DatasetDef `] .. .. !! processed by numpydoc !! Attribute detail ---------------- .. py:attribute:: logger :value: None .. py:attribute:: version .. py:attribute:: session :value: None Method detail ------------- .. py:method:: delete(db_path) Delete a database at the specified file location. :Parameters: **db_path** : :class:`python:str` Path to top-level database folder. .. !! processed by numpydoc !! .. py:method:: save() Save any changes into a file. .. !! processed by numpydoc !! .. py:method:: close(terminate_rpc_session=True) Close the database. :Parameters: **terminate_rpc_session** : :ref:`bool `, :obj:`optional` Terminate RPC session when closing the database. The default value is `True`. **. note::** Unsaved changes will be lost. If multiple databases are open and RPC session is terminated, the connection with all databases will be lost. You might be careful and set to `False` until the last open database remains. .. !! processed by numpydoc !! .. py:method:: find_by_id(db_id) Find a database by ID. :Parameters: **db_id** : :class:`python:int` The Database's unique EDB id. :Returns: :obj:`Database` The Database or Null on failure. .. !! processed by numpydoc !! .. py:method:: save_as(path, version='') Save this Database to a new location and older EDB version. :Parameters: **path** : :class:`python:str` New Database file location. **version** : :class:`python:str` EDB version to save to. Empty string means current version. .. !! processed by numpydoc !! .. py:method:: get_product_property(prod_id, attr_it) Get the product-specific property value. :Parameters: **prod_id** : :obj:`ProductIdType` Product ID. **attr_it** : :class:`python:int` Attribute ID. :Returns: :class:`python:str` Property value returned. .. !! processed by numpydoc !! .. py:method:: set_product_property(prod_id, attr_it, prop_value) Set the product property associated with the given product and attribute ids. :Parameters: **prod_id** : :obj:`ProductIdType` Product ID. **attr_it** : :class:`python:int` Attribute ID. **prop_value** : :class:`python:str` Product property's new value .. !! processed by numpydoc !! .. py:method:: get_product_property_ids(prod_id) Get a list of attribute ids corresponding to a product property id. :Parameters: **prod_id** : :obj:`ProductIdType` Product ID. :Returns: :class:`python:list`\[:class:`python:int`] The attribute ids associated with this product property. .. !! processed by numpydoc !! .. py:method:: import_material_from_control_file(control_file, schema_dir=None, append=True) Import materials from the provided control file. :Parameters: **control_file** : :class:`python:str` Control file name with full path. **schema_dir** : :class:`python:str` Schema file path. **append** : :ref:`bool ` True if the existing materials in Database are kept. False to remove existing materials in database. .. !! processed by numpydoc !! .. py:method:: scale(scale_factor) Uniformly scale all geometry and their locations by a positive factor. :Parameters: **scale_factor** : :class:`python:float` Amount that coordinates are multiplied by. .. !! processed by numpydoc !! .. py:method:: copy_cells(cells_to_copy) Copy Cells from other Databases or this Database into this Database. :Parameters: **cells_to_copy** : :class:`python:list`\[:class:`Cell `] Cells to copy. :Returns: :class:`python:list`\[:class:`Cell `] .. .. !! processed by numpydoc !!