File tree 2 files changed +9
-4
lines changed
2 files changed +9
-4
lines changed Original file line number Diff line number Diff line change @@ -59,11 +59,16 @@ python rules2yml.py # Generates the rule directory
59
59
osivalidator --data data/20240221T141700Z_sv_300_2112_10_one_moving_object.osi --rules rules -p
60
60
----
61
61
62
- The rules2yml.py generates yml files for all OSI proto files containing the rules specified in OSI.
63
- It also generated respective yml schema files to validate the rule yml files.
64
- The schema files are located in <rules_folder>/schema.
62
+ The rules2yml.py generates a yml file for each OSI proto file containing the rules specified in OSI.
63
+ The yml files are located in the specified rules folder given as an input parameter.
64
+ Additionally, the script generates respective yml schema files to validate the rule yml files in <rules_folder>/schema.
65
+ The schema files contain the message names of the original OSI proto file and a list of applicable rules.
66
+ If a rule has an associated value, e.g. a string or a number, the type of the value is also checked.
65
67
When executing osivalidator, all rule files are validated against their respective schema.
66
68
69
+ If needed, the rules folder can be copied and modified for specific use cases, e.g. by adding or removing certain rules.
70
+ This way, osivalidation can be used with different sets of rules.
71
+
67
72
After successfully running the validation the following output is
68
73
generated:
69
74
Original file line number Diff line number Diff line change @@ -46,7 +46,7 @@ def command_line_arguments():
46
46
parser .add_argument (
47
47
"--rules" ,
48
48
"-r" ,
49
- help = "Directory with text files containig rules. " ,
49
+ help = "Directory with yml files containing rules. " ,
50
50
default = os .path .join (dir_path , "rules" ),
51
51
type = str ,
52
52
)
You can’t perform that action at this time.
0 commit comments