class documentation

class Bookmark:

View In Hierarchy

A Bookmark saved on the Reven server for this project.

Bookmarks allow to bookmark a specific trace.Transition and can have an associated textual description. Bookmarks appear in Axion and can be useful to save the location of points of interest in the trace.

Method __init__ Undocumented
Method __repr__ Undocumented
Method __str__ Returns the nicely printable string representation of this instance.
Method edit Attempts to modify the description of the bookmark on the server.
Method format_as_html This method gets an html formatting string representation for this class instance.
Method refresh Requests a fresh view of this bookmark from the server.
Property description Property: The description of this bookmark
Property id Property: The internal id of a bookmark.
Property transition Property: The bookmarked transition
Method _repr_html_ Representation used by Jupyter Notebook when an instance of this class is displayed in a cell.
Instance Variable _datasource Undocumented
Instance Variable _id Undocumented
Property _bookmark Undocumented
def __init__(self, _id, _datasource):

Undocumented

def __repr__(self):

Undocumented

def __str__(self):

Returns the nicely printable string representation of this instance.

Returns
strUndocumented
def edit(self, description):

Attempts to modify the description of the bookmark on the server.

Information

Parameters
descriptionA str that will replace the current description of this bookmark.
Raises
ValueErrorIf called on a bookmark that has been deleted server-side. This can happen if the bookmark was deleted since the last call to Bookmarks.refresh.
RuntimeErrorIf called on a bookmark that is being edited or have been edited since the last refresh by another client (e.g. Axion).
def format_as_html(self):

This method gets an html formatting string representation for this class instance.

Information

Returns
String
def refresh(self):

Requests a fresh view of this bookmark from the server.

This will retrieve changes made by other clients to this bookmark (Axion, or another script). You should call this method when you know other clients modified the bookmarks of this project.

@property
description =

Property: The description of this bookmark

@property
id =

Property: The internal id of a bookmark.

For two bookmarks of a given project, the bookmark with the lowest id has been added the earliest, chronologically.

@property
transition =

Property: The bookmarked transition

def _repr_html_(self):

Representation used by Jupyter Notebook when an instance of this class is displayed in a cell.

_datasource =

Undocumented

_id =

Undocumented

@property
_bookmark =

Undocumented