Python API¶
The TimingAnalyzer class is the main application class. It is assigned to the variable taApp automatically as the interpreter is initialized. It controls most all of the GUI related functions in the main window like multiple tabs for timing diagrams, the menus, the toolbar, and the status bar. It also controls switching from the timing diagram view to the image view and other views that might be added in the future. Possibly a “transaction editor” diagram view, or “analysis reports” view.
TimingDiagram¶
- app.get_timing_diagram(taApp)¶
Get the current timing diagram
This function returns a reference to the current timing diagram being displayed.
- Args:
taApp: A reference to the TimingAnalyzer
- Returns:
td: A reference to the displayed timing diagram
- Example:
td = get_timing_diagram(taApp)
- app.new_timing_diagram(taApp, dir=None, file_name=None)¶
Start a new timing diagram.
This function initializes a new timing diagram and displays in the a new tabbed window.
- Args:
dir: specifies the directory to save the timing diagram file
file_name: Specifies the file name used for this new timing diagram.
- Returns:
td: A reference to the new timing diagram
- Examples:
td = new_timing_diagram(taApp)
td = new_timing_diagram(taApp, ‘scripts’, ‘PCI_Read.tim’)
File I/O¶
- app.get_file_name(taApp)¶
Get the file name of the current timing diagram
- Args:
taApp: A reference to the TimingAnalyzer
- Returns:
file_name: The file name String
- Example:
fn = get_file_name(taApp)
- app.file_save(taApp)¶
Save the current timing diagram
This function save the current timing diagram using the dir and file_name.
- Args:
taApp: A reference to TimingAnalyzer
- Returns:
None:
- Example:
file_save(taApp)
- app.get_abs_file_path(taApp)¶
Get the absolute file path for the current timing diagram
- Args:
taApp: A reference to the TimingAnalyzer
- Returns:
file_dir: The directory path name String
- Example:
fp = get_abs_file_path(taApp)