add_report

VirtualComplianceGenerator.add_report(design_name: str, config_file: str | Path, traces: list, report_type: str, pass_fail: bool, group_plots: bool, name: str, project: str | None = None) → None

Add Com parameters computed by SpiSim into the configuration.

Parameters:

design_namestr

Design name.

config_filestr

Full path to cfg file.

traceslist

List of traces to compute com parameters.

report_typestr

Report Type.

pass_failbool

Whether if to compute pass fail on this parameter or not.

group_plotsbool

Whether if to group all the traces in the same plot or not.

namestr, optional

Name of the report.

projectstr, optional

Full path to the project to use for the computation of this report. If None the default project will be used.

Examples

>>> from ansys.aedt.core.visualization.post.compliance import VirtualComplianceGenerator
>>> obj = VirtualComplianceGenerator()
>>> obj.add_report(
...     design_name=1,
...     config_file="example.cfg",
...     traces=["Box1"],
...     report_type=1,
...     pass_fail=True,
...     group_plots=True,
...     name="MyObject",
... )