chipscopy.api.ibert.link.group

chipscopy.api.ibert.create_link_groups(descriptions)

Create a link group for with description

Parameters

descriptions (Union[str, List[str]]) – Description(s) for the link group(s) to create.

Return type

QueryList[LinkGroup]

Returns

Newly created link groups.

chipscopy.api.ibert.delete_link_groups(link_groups, *, delete_links_in_group=False)

Delete link group(s)

Parameters

• link_groups (Union[LinkGroup, List[LinkGroup], QueryList[LinkGroup]]) – The link groups to delete

• delete_links_in_group (bool) – If set to True the links within each link group are deleted as well. Default behavior is to disassociate the link from the link group and not delete the link itself.

Returns:

chipscopy.api.ibert.get_all_link_groups()

Get all LinkGroup object(s)

Return type

QueryList[LinkGroup]

Returns

List of link groups(s)

class chipscopy.api.ibert.link.group.LinkGroup(name, description, _links, filter_by=<factory>)

Container class for holding links. Please do not create an instance of this class directly. Please use the factory method create_link_group() instead.

add(links)

Add link(s) to the link group

Parameters

links (Union[ForwardRef, List[ForwardRef], QueryList[ForwardRef]]) – Link(s) to add

description: str

Description of this link group

filter_by: Dict[str, Any]

invalidate()

property links: chipscopy.api.containers.QueryList[Link]

Return type

QueryList[ForwardRef]

name: str

Name of the link group

remove(links=None)

Remove link(s) from the link group

Parameters

links (Union[ForwardRef, List[ForwardRef], QueryList[ForwardRef]]) – (Optional) Link(s) to remove

Note

If no link(s) is(are) provided, all links in the link group, will be removed