Module pynebv

neoEBV access module

This module provides access to neoEBV. It mainly provides instances of section classes that collect methods for each function provided by neoEBV. Each section has its own methods, and these methods are used to execute the functions of neoEBV. In neoEBV, the elements handled in each function are treated as items, and for example, when an OASIS® file is opened, an item of type Chip is returned. This item also has attributes and methods according to its type, and can be operated through them.

chip = pynebv.file.open('/path/to/shape.oas')
chip.color = 'Red'
chip.close()

For the functions of sections and items, see their respective descriptions.

Global variables

var LIBPYTHON_PATH

Path of libpython3 currently loaded.

var NEBV_BUILD_VERSION

Version of neoEBV created simultaneously with pynebv.

var NEBV_RUNTIME_VERSION

Version of neoEBV currently in use.

var VERSION

Version of pynebv.

var file

FileList instance.

See FileList page.

var mark

MarkList instance.

See MarkList page.

var mark_table

MarkTableList instance.

See MarkList page.

var calculation

CalculationList instance.

See CalculationList page.

var inspection

InspectionList instance.

See InspectionList page.

var measurement

Measurement instance.

See Measurement page.

var measurement_point

MeasurementPointList instance.

See Measurement page.

var measurement_alignment

MeasurementAlignmentList instance.

See Measurement page.

var measurement_ls_detect

MeasurementLsDetectList instance.

See Measurement page.

var matching_template

MatchingTemplateList instance.

See MatchingTemplateList page.

var matching_template_measurement

MatchingTemplateMeasurementList instance.

See MatchingTemplateList page.

var registration

RegistrationList instance.

See RegistrationList page.

var screen

Screen instance.

See Screen page.

var figure

Figure instance.

See Figure page.

var preference

Preference instance.

See Preference page.

Functions

def quit(exitCode=0)

Quit neoEBV.

Args

exitCode : int

Exit code.

Returns

none
Always none.

Classes

Section Classes

class EbvListSection

EbvListSection

Base class for all List Sections.

Examples

# List up oas files.
oasis_files = pynebv.file.items('*.oas')
# Make them red in color.
oasis_files.color = 'red'

Subclasses

Methods

def item(searchName='')

Get an item which is match with condition.

Args

searchName : str

Specify name to search. This allows matching patterns commonly seen in file names, like using '*'.

Returns

EbvItem
Return an item which is match with condition.
def items(searchName='')

Get items which are match with condition.

Args

searchName : str

Specify name to search. This allows matching patterns commonly seen in file names, like using '*'.

Returns

EbvItemList
Return items which are match with condition.
def list()

Get list of top level items.

Returns

EbvItemList
Return list of top level items.

Item Classes

class EbvItem

EbvItem

Base class for all EbvItems.

Examples

# Pickup items by class.
items = pynebv.file.items()
for item in items:
  if not(type(item) is pynebv.TopCell):
    continue
  print(item.display_name + ": " + str(type(item)))
  print("  : " + str(item.props()) + ": " + str(item.attributes()))

# Pickup top level items.
items = pynebv.file.list()
for item in items:
  print(item.display_name + ": " + str(type(item)))
  print("  : " + str(item.props()) + ": " + str(item.attributes()))

# Pickup items by name.
#  prepare
pynebv.mark.add((100,100), "PointOne")
pynebv.mark.add((200,200), "PointTwo")
#  pickup
items = pynebv.mark.items("*Tw*")
for item in items:
  print(item.name + ": " + str(type(item)))
  print("  : " + str(item.props()) + ": " + str(item.attributes()))

Subclasses

Instance variables

var color : str

Color of shapes.

var display : bool

Display item in screen or not.

Methods

def attributes()

Get all item attributes.

Returns

dict
Return all item attributes.
def descendant(searchName='', onlyDirectChildren=False)

Pickup a descendant item.

Args

searchName : str

Specify name to search. This allows matching patterns commonly seen in file names, like using '*'.

onlyDirectChildren : bool

Specify whether to get descendants recursively.

Returns

EbvItem
Return a descendant item which is match with condition.
def descendants(searchName='', onlyDirectChildren=False)

Pickup all descendant items.

Args

searchName : str

Specify name to search. This allows matching patterns commonly seen in file names, like using '*'.

onlyDirectChildren : bool

Specify whether to get descendants recursively.

Returns

EbvItemList
Return all descendant items which are match with condition.
def is_dangling()

Get whether the item does not exist in the neoEBV.

Returns

bool
Return whether the item does not exist in the neoEBV.
def props()

Get all item properties.

Returns

dict[str, str]
Return all item properties.
def set_attributes(sets)

Set item attributes.

Args

sets : dict[str, str]

Specify item attributes.

Returns

none
Always none.
class EbvItemList (*args, **kwargs)

EbvItemList (list)

EbvItem List Class.

This is a list class that allows for the simultaneous invocation of methods and setting of attributes for its members when they are of type EbvItem. While typically used as the return value of a method that produces a list of EbvItems, it can also be instantiated and used independently.

Examples

# Operate multiple items at once.
# Note: That if the list is empty, the corresponding function cannot be determined
#       and an error will occur when executing access.
file_list_items_name_contains_1 = pynebv.file.items("*1*")
if len(file_list_items_name_contains_1) != 0:
    file_list_items_name_contains_1.color = "Red"
file_list_items_name_contains_err = pynebv.file.items("*err*")
if len(file_list_items_name_contains_err) != 0:
    file_list_items_name_contains_err.bold = True

Ancestors

  • builtins.list