reference_system_py::report

Functions

	Name
def	generate_summary_report(trace_type trace_type, pkg pkg, directory directory, runtime_sec runtime_sec, template_file template_file)
def	generate_report(trace_type trace_type, * args, ** kwargs)
def	generate_memory_report(executable executable, pkg pkg, directory directory, runtime_sec runtime_sec, rmw rmw)
def	generate_callback_report(executable executable, pkg pkg, directory directory, runtime_sec runtime_sec, rmw rmw)
def	fill_in_template(Path template_file, str report_title, dict figures)

Attributes

	Name
bool	tracetools_available

Functions Documentation

function generate_summary_report

def generate_summary_report(
    trace_type trace_type,
    pkg pkg,
    directory directory,
    runtime_sec runtime_sec,
    template_file template_file
)

Generate a summary report for the given `trace_type`, using all traces under `directory`.```


### function generate_report

```python
def generate_report(
    trace_type trace_type,
    * args,
    ** kwargs
)

function generate_memory_report

def generate_memory_report(
    executable executable,
    pkg pkg,
    directory directory,
    runtime_sec runtime_sec,
    rmw rmw
)

Generate a per-executable report from the 'memory' trace file.```


### function generate_callback_report

```python
def generate_callback_report(
    executable executable,
    pkg pkg,
    directory directory,
    runtime_sec runtime_sec,
    rmw rmw
)

Generate a per-executable report from the 'callback' trace file.```


### function fill_in_template

```python
def fill_in_template(
    Path template_file,
    str report_title,
    dict figures
)

Fill in the given tempalte file with the supplied figures.

template_file: Full path to template file, including template file name
report_title: Title of report
figures: Figures to insert into report

Attributes Documentation

variable tracetools_available

bool tracetools_available =  True;

---

Updated on 2023-09-17 at 15:43:17 +0000