KLayout Manual: Main Index » Class Index » API reference - Class ReportDatabase

API reference - Class ReportDatabase

Notation used in Ruby API documentation

Description: The report database object

A report database is organised around a set of items which are associated with cells and categories. Categories can be organised hierarchically by created sub-categories of other categories. Cells are associated with layout database cells and can come with a example instantiation if the layout database does not allow a unique association of the cells. Items in the database can have a variety of attributes: values, tags and an image object. Values are geometrical objects for example. Tags are a set of boolean flags and an image can be attached to an item to provide a screenshot for visualisation for example. This is the main report database object. The basic use case of this object is to create one inside a LayoutView and populate it with items, cell and categories or load it from a file. Another use case is to create a standalone ReportDatabase object and use the methods provided to perform queries or to populate it.

Public constructors

new ReportDatabasenew(string name)Create a report database

Public methods

[const]const RdbCategory ptrcategory_by_id(unsigned int id)Gets a category by ID
[const]const RdbCategory ptrcategory_by_path(string path)Gets a category by path
[const]const RdbCell ptrcell_by_id(unsigned int id)Returns the cell for a given ID
[const]const RdbCell ptrcell_by_qname(string qname)Returns the cell for a given qualified name
voidcreateEnsures the C++ object is created
RdbCategory ptrcreate_category(string name)Creates a new top level category
RdbCategory ptrcreate_category(RdbCategory ptr parent,
string name)		Creates a new sub-category
RdbCell ptrcreate_cell(string name)Creates a new cell
RdbCell ptrcreate_cell(string name,
string variant)		Creates a new cell, potentially as a variant for a cell with the same name
RdbItem ptrcreate_item(unsigned int cell_id,
unsigned int category_id)		Creates a new item for the given cell/category combination
voidcreate_items(unsigned int cell_id,
unsigned int category_id,
const CplxTrans trans,
const Region polygons)		Creates new polygon items for the given cell/category combination
voidcreate_items(unsigned int cell_id,
unsigned int category_id,
const CplxTrans trans,
const Edges edges)		Creates new edge items for the given cell/category combination
voidcreate_items(unsigned int cell_id,
unsigned int category_id,
const CplxTrans trans,
const EdgePairs edge_pairs)		Creates new edge pair items for the given cell/category combination
voidcreate_items(unsigned int cell_id,
unsigned int category_id,
const CplxTrans trans,
Polygon[] polygons)		Creates new polygon items for the given cell/category combination
voidcreate_items(unsigned int cell_id,
unsigned int category_id,
const CplxTrans trans,
Edge[] edges)		Creates new edge items for the given cell/category combination
voidcreate_items(unsigned int cell_id,
unsigned int category_id,
const CplxTrans trans,
EdgePair[] edge_pairs)		Creates new edge pair items for the given cell/category combination
[const]stringdescriptionGets the databases description
voiddescription=(string desc)Sets the databases description
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const,iter]RdbCategoryeach_categoryIterates over all top-level categories
[const,iter]RdbCelleach_cellIterates over all cells
[const,iter]RdbItemeach_itemIterates over all iterms inside the database
[const,iter]RdbItemeach_item_per_category(unsigned int category_id)Iterates over all iterms inside the database which are associated with the given category
[const,iter]RdbItemeach_item_per_cell(unsigned int cell_id)Iterates over all iterms inside the database which are associated with the given cell
[const,iter]RdbItemeach_item_per_cell_and_category(unsigned int cell_id,
unsigned int category_id)		Iterates over all iterms inside the database which are associated with the given cell and category
[const]stringfilenameGets the file name and path where the report database is stored
[const]stringgeneratorGets the databases generator
voidgenerator=(string generator)Sets the generator string
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]boolis_modified?Returns a value indicating whether the database has been modified
voidload(string filename)Loads the database from the given file
[const]stringnameGets the database name
[const]unsigned intnum_itemsReturns the number of items inside the database
[const]unsigned intnum_items(unsigned int cell_id,
unsigned int category_id)		Returns the number of items inside the database for a given cell/category combination
[const]unsigned intnum_items_visitedReturns the number of items already visited inside the database
[const]unsigned intnum_items_visited(unsigned int cell_id,
unsigned int category_id)		Returns the number of items visited already for a given cell/category combination
[const]stringoriginal_fileGets the original file name and path
voidoriginal_file=(string path)Sets the original file name and path
voidreset_modifiedReset the modified flag
voidsave(string filename)Saves the database to the given file
voidset_item_visited(const RdbItem ptr item,
bool visited)		Modifies the visited state of an item
voidset_tag_description(unsigned int tag_id,
string description)		Sets the tag description for the given tag ID
[const]stringtag_description(unsigned int tag_id)Gets the tag description for the given tag ID
[const]unsigned inttag_id(string name)Gets the tag ID for a given tag name
[const]stringtop_cell_nameGets the top cell name
voidtop_cell_name=(string cell_name)Sets the top cell name string
unsigned int[]variants(string name)Gets the variants for a given cell name

Detailed description

[const] const RdbCategory ptr category_by_id(unsigned int id)

Description: Gets a category by ID

Returns:The (const) category object or nil if the ID is not valid

[const] const RdbCategory ptr category_by_path(string path)

Description: Gets a category by path

path:The full path to the category starting from the top level (subcategories separated by dots)
Returns:The (const) category object or nil if the name is not valid

[const] const RdbCell ptr cell_by_id(unsigned int id)

Description: Returns the cell for a given ID

id:The ID of the cell
Returns:The cell object or nil if no cell with that ID exists

[const] const RdbCell ptr cell_by_qname(string qname)

Description: Returns the cell for a given qualified name

qname:The qualified name of the cell (name plus variant name optionally)
Returns:The cell object or nil if no such cell exists

void create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

RdbCategory ptr create_category(string name)

Description: Creates a new top level category

name:The name of the category

RdbCategory ptr create_category(RdbCategory ptr parent,string name)

Description: Creates a new sub-category

parent:The category under which the category should be created
name:The name of the category

RdbCell ptr create_cell(string name)

Description: Creates a new cell

name:The name of the cell

RdbCell ptr create_cell(string name,string variant)

Description: Creates a new cell, potentially as a variant for a cell with the same name

name:The name of the cell
variant:The variant name of the cell

RdbItem ptr create_item(unsigned int cell_id,unsigned int category_id)

Description: Creates a new item for the given cell/category combination

cell_id:The ID of the cell to which the item is associated
category_id:The ID of the category to which the item is associated

void create_items(unsigned int cell_id,unsigned int category_id,const CplxTrans trans,const Region polygons)

Description: Creates new polygon items for the given cell/category combination

cell_id:The ID of the cell to which the item is associated
category_id:The ID of the category to which the item is associated
trans:The transformation to apply
region:The region (a Region object) containing the polygons for which to create items

For each polygon in the region a single item will be created. The value of the item will be this polygon. A transformation can be supplied which can be used for example to convert the object's dimensions to micron units by scaling by the database unit.

This method has been introduced in version 0.23.

void create_items(unsigned int cell_id,unsigned int category_id,const CplxTrans trans,const Edges edges)

Description: Creates new edge items for the given cell/category combination

cell_id:The ID of the cell to which the item is associated
category_id:The ID of the category to which the item is associated
trans:The transformation to apply
edges:The list of edges (an Edges object) for which the items are created

For each edge a single item will be created. The value of the item will be this edge. A transformation can be supplied which can be used for example to convert the object's dimensions to micron units by scaling by the database unit.

This method has been introduced in version 0.23.

void create_items(unsigned int cell_id,unsigned int category_id,const CplxTrans trans,const EdgePairs edge_pairs)

Description: Creates new edge pair items for the given cell/category combination

cell_id:The ID of the cell to which the item is associated
category_id:The ID of the category to which the item is associated
trans:The transformation to apply
edges:The list of edge pairs (an EdgePairs object) for which the items are created

For each edge pair a single item will be created. The value of the item will be this edge pair. A transformation can be supplied which can be used for example to convert the object's dimensions to micron units by scaling by the database unit.

This method has been introduced in version 0.23.

void create_items(unsigned int cell_id,unsigned int category_id,const CplxTrans trans,Polygon[] polygons)

Description: Creates new polygon items for the given cell/category combination

cell_id:The ID of the cell to which the item is associated
category_id:The ID of the category to which the item is associated
trans:The transformation to apply
polygons:The list of polygons for which the items are created

For each polygon a single item will be created. The value of the item will be this polygon. A transformation can be supplied which can be used for example to convert the object's dimensions to micron units by scaling by the database unit.

This method has been introduced in version 0.23.

void create_items(unsigned int cell_id,unsigned int category_id,const CplxTrans trans,Edge[] edges)

Description: Creates new edge items for the given cell/category combination

cell_id:The ID of the cell to which the item is associated
category_id:The ID of the category to which the item is associated
trans:The transformation to apply
edges:The list of edges for which the items are created

For each edge a single item will be created. The value of the item will be this edge. A transformation can be supplied which can be used for example to convert the object's dimensions to micron units by scaling by the database unit.

This method has been introduced in version 0.23.

void create_items(unsigned int cell_id,unsigned int category_id,const CplxTrans trans,EdgePair[] edge_pairs)

Description: Creates new edge pair items for the given cell/category combination

cell_id:The ID of the cell to which the item is associated
category_id:The ID of the category to which the item is associated
trans:The transformation to apply
edge_pairs:The list of edge_pairs for which the items are created

For each edge pair a single item will be created. The value of the item will be this edge pair. A transformation can be supplied which can be used for example to convert the object's dimensions to micron units by scaling by the database unit.

This method has been introduced in version 0.23.

[const] string description

Description: Gets the databases description

Returns:The description string

The description is a general purpose string that is supposed to further describe the database and it's content in a human-readable form.

void description=(string desc)

Description: Sets the databases description

desc:The description string

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const,iter] RdbCategory each_category

Description: Iterates over all top-level categories

[const,iter] RdbCell each_cell

Description: Iterates over all cells

[const,iter] RdbItem each_item

Description: Iterates over all iterms inside the database

[const,iter] RdbItem each_item_per_category(unsigned int category_id)

Description: Iterates over all iterms inside the database which are associated with the given category

category_id:The ID of the category for which all associated items should be retrieved

[const,iter] RdbItem each_item_per_cell(unsigned int cell_id)

Description: Iterates over all iterms inside the database which are associated with the given cell

cell_id:The ID of the cell for which all associated items should be retrieved

[const,iter] RdbItem each_item_per_cell_and_category(unsigned int cell_id,unsigned int category_id)

Description: Iterates over all iterms inside the database which are associated with the given cell and category

cell_id:The ID of the cell for which all associated items should be retrieved
category_id:The ID of the category for which all associated items should be retrieved

[const] string filename

Description: Gets the file name and path where the report database is stored

Returns:The file name and path

This property is set when a database is saved or loaded. It cannot be set manually.

[const] string generator

Description: Gets the databases generator

Returns:The generator string

The generator string describes how the database was created, i.e. DRC tool name and tool options. In a later version this should allow to rerun the tool that created the report.

void generator=(string generator)

Description: Sets the generator string

generator:The generator string

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

[const] bool is_modified?

Description: Returns a value indicating whether the database has been modified

void load(string filename)

Description: Loads the database from the given file

filename:The file from which to load the database

The reader recognizes the format automatically and will choose the appropriate decoder. 'gzip' compressed files are uncompressed automatically.

[const] string name

Description: Gets the database name

Returns:The database name

The name of the database is supposed to identify the database within a layout view context. The name is modified to be unique when a database is entered into a layout view.

[static] new ReportDatabase new(string name)

Description: Create a report database

name:The name of the database

The name of the database will be used in the user interface to refer to a certain database.

[const] unsigned int num_items

Description: Returns the number of items inside the database

Returns:The total number of items

[const] unsigned int num_items(unsigned int cell_id,unsigned int category_id)

Description: Returns the number of items inside the database for a given cell/category combination

cell_id:The ID of the cell for which to retrieve the number
category_id:The ID of the category for which to retrieve the number
Returns:The total number of items for the given cell and the given category

[const] unsigned int num_items_visited

Description: Returns the number of items already visited inside the database

Returns:The total number of items already visited

[const] unsigned int num_items_visited(unsigned int cell_id,unsigned int category_id)

Description: Returns the number of items visited already for a given cell/category combination

cell_id:The ID of the cell for which to retrieve the number
category_id:The ID of the category for which to retrieve the number
Returns:The total number of items visited for the given cell and the given category

[const] string original_file

Description: Gets the original file name and path

Returns:The original file name and path

The original file name is supposed to describe the file from which this report database was generated.

void original_file=(string path)

Description: Sets the original file name and path

path:The path

void reset_modified

Description: Reset the modified flag

void save(string filename)

Description: Saves the database to the given file

filename:The file to which to save the database

The database is always saved in KLayout's XML-based format.

void set_item_visited(const RdbItem ptr item,bool visited)

Description: Modifies the visited state of an item

item:The item to modify
visited:True to set the item to visited state, false otherwise

void set_tag_description(unsigned int tag_id,string description)

Description: Sets the tag description for the given tag ID

tag_id:The ID of the tag
description:The description string

[const] string tag_description(unsigned int tag_id)

Description: Gets the tag description for the given tag ID

tag_id:The ID of the tag
Returns:The description string

[const] unsigned int tag_id(string name)

Description: Gets the tag ID for a given tag name

name:The tag name
Returns:The corresponding tag ID

This method will always succeed and the tag will be created if it does not exist yet.

[const] string top_cell_name

Description: Gets the top cell name

Returns:The top cell name

The top cell name identifies the top cell of the design for which the report was generated. This property must be set to establish a proper hierarchical context for a hierarchical report database.

void top_cell_name=(string cell_name)

Description: Sets the top cell name string

cell_name:The top cell name

unsigned int[] variants(string name)

Description: Gets the variants for a given cell name

name:The basic name of the cell
Returns:An array of ID's representing cells that are variants for the given base name