create_compliance_report

VirtualCompliance.create_compliance_report(file_name: str = 'compliance_test.pdf', close_project: bool = True) → str

Create the Virtual Compliance report.

Parameters:

file_namestr

Output file name.

close_projectbool, optional

Whether to close the project at the end of the report generation or not. Default is True.

Returns:

str

Path to the output file.

Examples

>>> from ansys.aedt.core.visualization.post.compliance import VirtualCompliance
>>> obj = VirtualCompliance()
>>> obj.create_compliance_report(file_name="example.pdf", close_project=True)