EdbInit

class pyedb.grpc.edb_init.EdbInit(edbversion)

Bases: object

Edb Dot Net Class.

Overview

Methods

delete	Delete a database at the specified file location.
save	Save any changes into a file.
close	Close the database.
find_by_id	Find a database by ID.
save_as	Save this Database to a new location and older EDB version.
get_product_property	Get the product-specific property value.
set_product_property	Set the product property associated with the given product and attribute ids.
get_product_property_ids	Get a list of attribute ids corresponding to a product property id.
import_material_from_control_file	Import materials from the provided control file.
scale	Uniformly scale all geometry and their locations by a positive factor.
copy_cells	Copy Cells from other Databases or this Database into this Database.

Properties

db	Active database object.
top_circuit_cells	Get top circuit cells.
circuit_cells	Get all circuit cells in the Database.
footprint_cells	Get all footprint cells in the Database.
edb_uid	Get ID of the database.
is_read_only	Determine if the database is open in a read-only mode.
directory	Get the directory of the Database.
source	Get source name for this Database.
source_version	Get the source version for this Database.
apd_bondwire_defs	Get all APD bondwire definitions in this Database.
jedec4_bondwire_defs	Get all JEDEC4 bondwire definitions in this Database.
jedec5_bondwire_defs	Get all JEDEC5 bondwire definitions in this Database.
padstack_defs	Get all Padstack definitions in this Database.
package_defs	Get all Package definitions in this Database.
component_defs	Get all component definitions in the database.
material_defs	Get all material definitions in the database.
dataset_defs	Get all dataset definitions in the database.

Attributes

logger
version
session

Import detail

from pyedb.grpc.edb_init import EdbInit

Property detail

property EdbInit.db

Active database object.

property EdbInit.top_circuit_cells

Get top circuit cells.

Returns:

list[Cell]

property EdbInit.circuit_cells

Get all circuit cells in the Database.

Returns:

list[Cell]

property EdbInit.footprint_cells

Get all footprint cells in the Database.

Returns:

list[Cell]

property EdbInit.edb_uid

Get ID of the database.

Returns:

int

The unique EDB id of the Database.

property EdbInit.is_read_only

Determine if the database is open in a read-only mode.

Returns:

bool

True if Database is open with read only access, otherwise False.

property EdbInit.directory

Get the directory of the Database.

Returns:

str

Directory of the Database.

property EdbInit.source

Get source name for this Database.

This attribute is also used to set the source name.

Returns:

str

name of the source

property EdbInit.source_version

Get the source version for this Database.

This attribute is also used to set the version.

Returns:

str

version string

property EdbInit.apd_bondwire_defs

Get all APD bondwire definitions in this Database.

Returns:

list[ApdBondwireDef]

property EdbInit.jedec4_bondwire_defs

Get all JEDEC4 bondwire definitions in this Database.

Returns:

list[Jedec4BondwireDef]

property EdbInit.jedec5_bondwire_defs

Get all JEDEC5 bondwire definitions in this Database.

Returns:

list[Jedec5BondwireDef]

property EdbInit.padstack_defs

Get all Padstack definitions in this Database.

Returns:

list[PadstackDef]

property EdbInit.package_defs

Get all Package definitions in this Database.

Returns:

list[PackageDef]

property EdbInit.component_defs

Get all component definitions in the database.

Returns:

list[ComponentDef]

property EdbInit.material_defs

Get all material definitions in the database.

Returns:

list[MaterialDef]

property EdbInit.dataset_defs

Get all dataset definitions in the database.

Returns:

list[DatasetDef]

Attribute detail

EdbInit.logger = None

EdbInit.version

EdbInit.session = None

Method detail

EdbInit.delete(db_path)

Delete a database at the specified file location.

Parameters:

db_pathstr

Path to top-level database folder.

EdbInit.save()

Save any changes into a file.

EdbInit.close(terminate_rpc_session=True)

Close the database.

Parameters:

terminate_rpc_sessionbool, 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.

EdbInit.find_by_id(db_id)

Find a database by ID.

Parameters:

db_idint

The Database’s unique EDB id.

Returns:

Database

The Database or Null on failure.

EdbInit.save_as(path, version='')

Save this Database to a new location and older EDB version.

Parameters:

pathstr

New Database file location.

versionstr

EDB version to save to. Empty string means current version.

EdbInit.get_product_property(prod_id, attr_it)

Get the product-specific property value.

Parameters:

prod_idProductIdType

Product ID.

attr_itint

Attribute ID.

Returns:

str

Property value returned.

EdbInit.set_product_property(prod_id, attr_it, prop_value)

Set the product property associated with the given product and attribute ids.

Parameters:

prod_idProductIdType

Product ID.

attr_itint

Attribute ID.

prop_valuestr

Product property’s new value

EdbInit.get_product_property_ids(prod_id)

Get a list of attribute ids corresponding to a product property id.

Parameters:

prod_idProductIdType

Product ID.

Returns:

list[int]

The attribute ids associated with this product property.

EdbInit.import_material_from_control_file(control_file, schema_dir=None, append=True)

Import materials from the provided control file.

Parameters:

control_filestr

Control file name with full path.

schema_dirstr

Schema file path.

appendbool

True if the existing materials in Database are kept. False to remove existing materials in database.

EdbInit.scale(scale_factor)

Uniformly scale all geometry and their locations by a positive factor.

Parameters:

scale_factorfloat

Amount that coordinates are multiplied by.

EdbInit.copy_cells(cells_to_copy)

Copy Cells from other Databases or this Database into this Database.

Parameters:

cells_to_copylist[Cell]

Cells to copy.

Returns:

list[Cell]