Skip to content

Commit

Permalink
Add example config file in doc (#78)
Browse files Browse the repository at this point in the history
Signed-off-by: hoangtungdinh <[email protected]>
  • Loading branch information
hoangtungdinh committed Oct 31, 2024
1 parent ab35aac commit 8ded364
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This project implements the [ASAM OpenDrive Checker Bundle](checker_bundle_doc.m
- [Register Checker Bundle to ASAM Quality Checker Framework](#register-checker-bundle-to-asam-quality-checker-framework)
- [Linux Manifest Template](#linux-manifest-template)
- [Windows Manifest Template](#windows-manifest-template)
- [Example Configuration File](#example-configuration-file)
- [Tests](#tests)
- [Execute tests](#execute-tests)
- [Contributing](#contributing)
Expand Down Expand Up @@ -150,6 +151,31 @@ If the asam-qc-opendrive is installed in a virtual environment, the `exec_comman

Replace `C:\\> <venv>\\Scripts\\activate.bat` by the path to your virtual environment.

### Example Configuration File

An example configuration file for using this Checker Bundle within the ASAM Quality Checker Framework is as follows.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<Config>

<Param name="InputFile" value="test.xodr" />

<CheckerBundle application="xodrBundle">
<Param name="resultFile" value="xodr_bundle_report.xqar" />
<Checker checkerId="semantic_xodr" maxLevel="1" minLevel="3" />
<Checker checkerId="geometry_xodr" maxLevel="1" minLevel="3" />
<Checker checkerId="performance_xodr" maxLevel="1" minLevel="3" />
</CheckerBundle>

<ReportModule application="TextReport">
<Param name="strInputFile" value="Result.xqar" />
<Param name="strReportFile" value="Report.txt" />
</ReportModule>

</Config>
```

## Tests

To run the tests, you need to install the extra test dependency.
Expand Down

0 comments on commit 8ded364

Please sign in to comment.