Xorn storage backend. More...
Classes | |
| class | Arc |
| Schematic arc. More... | |
| class | Box |
| Schematic box. More... | |
| class | Circle |
| Schematic circle. More... | |
| class | Component |
| Schematic component. More... | |
| class | FillAttr |
| Schematic fill style. More... | |
| class | Line |
| Schematic line. More... | |
| class | LineAttr |
| Schematic line style. More... | |
| class | Net |
| Schematic net segment, bus segment, or pin. More... | |
| class | Object |
| The identity of an object across revisions. More... | |
| class | Path |
| Schematic path. More... | |
| class | Picture |
| Schematic picture. More... | |
| class | Revision |
| A particular state of the contents of a file. More... | |
| class | Selection |
| The identity of a set of objects across revisions. More... | |
| class | Text |
| Schematic text or attribute. More... | |
Functions | |
| def | get_objects_attached_to |
| Return a list of objects in a revision which are attached to a certain object. More... | |
| def | get_selected_objects |
| Return a list of objects which are in a revision as well as in a selection. More... | |
| def | get_added_objects |
| Return a list of objects which are in one revision but not in another. More... | |
| def | get_removed_objects |
| Return a list of objects which are in one revision but not in another. More... | |
| def | get_modified_objects |
| Return a list of objects which exist in two revisions but have different type or data. More... | |
| def | select_none |
| Return an empty selection. More... | |
| def | select_object |
| Return a selection containing a single object. More... | |
| def | select_attached_to |
| Return a selection containing all objects in a revision attached to a given object. More... | |
| def | select_all |
| Return a selection containing all objects in a revision. More... | |
| def | select_all_except |
| Return a selection containing all objects in a revision except those in a given selection. More... | |
| def | select_including |
| Return a selection which contains all the objects in an existing selection plus a given object. More... | |
| def | select_excluding |
| Return a selection which contains all the objects in an existing selection minus a given object. More... | |
| def | select_union |
| Return a selection containing the objects in either given selection. More... | |
| def | select_intersection |
| Return a selection containing the objects in both given selections. More... | |
| def | select_difference |
| Return a selection containing the objects contained in one given selection, but not the other. More... | |
| def | selection_is_empty |
| Return whether a selection is empty in a given revision. More... | |
| def | object_is_selected |
| Return whether an object exists in a revision and is selected in a selection. More... | |
Xorn storage backend.
Python extension providing access to the storage library.
| def xorn.storage.get_added_objects | ( | from, | |
| to | |||
| ) |
Return a list of objects which are in one revision but not in another.
Returns objects in to which are not in from. They are not necessarily returned in a meaningful order.
| MemoryError | if there is not enough memory |
Definition at line 354 of file storage.py.
| def xorn.storage.get_modified_objects | ( | from, | |
| to | |||
| ) |
Return a list of objects which exist in two revisions but have different type or data.
The objects are not necessarily returned in a meaningful order.
| MemoryError | if there is not enough memory |
Definition at line 375 of file storage.py.
| def xorn.storage.get_objects_attached_to | ( | rev, | |
| ob | |||
| ) |
Return a list of objects in a revision which are attached to a certain object.
If ob is None, return all objects in the revision which are not attached. The objects are returned in their actual order. Objects attached to the returned objects are not returned.
| KeyError | if ob is not None and does not exist in rev |
| MemoryError | if there is not enough memory |
Definition at line 333 of file storage.py.
| def xorn.storage.get_removed_objects | ( | from, | |
| to | |||
| ) |
Return a list of objects which are in one revision but not in another.
Returns objects in from which are not in to. They are not necessarily returned in a meaningful order.
| MemoryError | if there is not enough memory |
Definition at line 365 of file storage.py.
| def xorn.storage.get_selected_objects | ( | rev, | |
| sel | |||
| ) |
Return a list of objects which are in a revision as well as in a selection.
The objects are not necessarily returned in a meaningful order.
| MemoryError | if there is not enough memory |
Definition at line 343 of file storage.py.
| def xorn.storage.object_is_selected | ( | rev, | |
| sel, | |||
| ob | |||
| ) |
Return whether an object exists in a revision and is selected in a selection.
Definition at line 466 of file storage.py.
| def xorn.storage.select_all | ( | rev | ) |
Return a selection containing all objects in a revision.
| MemoryError | if there is not enough memory |
Definition at line 408 of file storage.py.
| def xorn.storage.select_all_except | ( | rev, | |
| sel | |||
| ) |
Return a selection containing all objects in a revision except those in a given selection.
| MemoryError | if there is not enough memory |
Definition at line 416 of file storage.py.
| def xorn.storage.select_attached_to | ( | rev, | |
| ob | |||
| ) |
Return a selection containing all objects in a revision attached to a given object.
The object may be None, in which case the selection contains all objects which are not attached.
| KeyError | if ob is not None and does not exist in rev |
| MemoryError | if there is not enough memory |
Definition at line 401 of file storage.py.
| def xorn.storage.select_difference | ( | sel0, | |
| sel1 | |||
| ) |
Return a selection containing the objects contained in one given selection, but not the other.
| MemoryError | if there is not enough memory |
Definition at line 455 of file storage.py.
| def xorn.storage.select_excluding | ( | sel, | |
| ob | |||
| ) |
Return a selection which contains all the objects in an existing selection minus a given object.
| MemoryError | if there is not enough memory |
Definition at line 432 of file storage.py.
| def xorn.storage.select_including | ( | sel, | |
| ob | |||
| ) |
Return a selection which contains all the objects in an existing selection plus a given object.
| MemoryError | if there is not enough memory |
Definition at line 424 of file storage.py.
| def xorn.storage.select_intersection | ( | sel0, | |
| sel1 | |||
| ) |
Return a selection containing the objects in both given selections.
| MemoryError | if there is not enough memory |
Definition at line 447 of file storage.py.
| def xorn.storage.select_none | ( | ) |
Return an empty selection.
| MemoryError | if there is not enough memory |
Definition at line 382 of file storage.py.
| def xorn.storage.select_object | ( | ob | ) |
Return a selection containing a single object.
| MemoryError | if there is not enough memory |
Definition at line 389 of file storage.py.
| def xorn.storage.select_union | ( | sel0, | |
| sel1 | |||
| ) |
Return a selection containing the objects in either given selection.
| MemoryError | if there is not enough memory |
Definition at line 440 of file storage.py.
| def xorn.storage.selection_is_empty | ( | rev, | |
| sel | |||
| ) |
Return whether a selection is empty in a given revision.
Definition at line 460 of file storage.py.
1.8.8