@@ -191,7 +191,7 @@ The Shape application allows the following parameters:
191191 Default: 33ms
192192 --read-period <ms> : waiting period between 'read()' or 'take()' operations
193193 in ms. Default: 100ms
194- --time-filter <interval> : apply 'time based filter' with interval
194+ --time-filter <interval> : apply 'time based filter' with interval
195195 in ms [0: OFF]
196196 --lifespan <int> : indicates the lifespan of a sample in ms
197197 --num-iterations <int>: indicates the number of iterations of the main loop
@@ -225,7 +225,8 @@ The Shape application allows the following parameters:
225225 large data)
226226 --take-read : uses take()/read() instead of take_next_instance()
227227 read_next_instance()
228-
228+ --periodic-announcement <ms> : indicates the periodic participant
229+ announcement period in ms. Default 0 (off)
229230~~~
230231
231232## Return Code
@@ -356,62 +357,72 @@ The `interoperability_report.py` may configure the following options:
356357$ python3 interoperability_report.py -h
357358
358359usage: interoperability_report.py [-h] -P publisher_executable_name -S subscriber_executable_name
359- [-v] [-s test_suite_dictionary_file ]
360- [-t test_cases [test_cases ...] | -d
361- test_cases_disabled
362- [test_cases_disabled ...]] [ -o filename]
360+ [-v] [-x {1,2}] [-a periodic_announcement_period ]
361+ [-s test_suite_dictionary_file]
362+ [-t test_cases [test_cases ...] | -d test_cases_disabled [test_cases_disabled ...]]
363+ [-o filename]
363364
364- Validation of interoperability of products compliant with OMG DDS-RTPS
365- standard. This script generates automatically the verification between two
366- shape_main executables. It also generates an XML report in JUnit format.
365+ Validation of interoperability of products compliant with OMG DDS-RTPS standard.
366+ This script generates automatically the verification between two shape_main
367+ executables. It also generates an XML report in JUnit format.
367368
368369optional arguments:
369370 -h, --help show this help message and exit
370371
371372general options:
372373 -P publisher_executable_name, --publisher publisher_executable_name
373- Path to the Publisher shape_main application. It may
374- be absolute or relative path. Example: if the
375- executable is in the same folder as the script: "-P
376- ./rti_connext_dds-6.1.1_shape_main_linux".
374+ Path to the Publisher shape_main application. It may be
375+ absolute or relative path. Example: if the executable is
376+ in the same folder as the script:
377+ "-P ./rti_connext_dds-6.1.1_shape_main_linux".
377378 -S subscriber_executable_name, --subscriber subscriber_executable_name
378- Path to the Subscriber shape_main application. It may
379- be absolute or relative path. Example: if the
380- executable is in the same folder as the script: "-S
381- ./rti_connext_dds-6.1.1_shape_main_linux".
379+ Path to the Subscriber shape_main application. It may be
380+ absolute or relative path. Example: if the executable is
381+ in the same folder as the script:
382+ "-S ./rti_connext_dds-6.1.1_shape_main_linux".
382383
383384optional parameters:
384385 -v, --verbose Print debug information to stdout. This option also
385386 shows the shape_main application output in case of
386- error. If this option is not used, only the test
387- results are printed in the stdout. (Default: False).
387+ error. If this option is not used, only the test results
388+ are printed in the stdout.
389+ Default: False.
390+ -x {1,2}, --data-representation {1,2}
391+ Data Representation used if no provided when running the
392+ shape_main application. If this application already sets
393+ the data representation, this parameter is not used. The
394+ potential values are 1 for XCDR1 and 2 for XCDR2.
395+ Default value 2.
396+ -a periodic_announcement_period, --periodic-announcement periodic_announcement_ms
397+ Indicates the periodic participant announcement period in ms.
398+ Default: 0 (off).
388399
389400Test Case and Test Suite:
390401 -s test_suite_dictionary_file, --suite test_suite_dictionary_file
391402 Test Suite that is going to be tested. Test Suite is a
392403 file with a Python dictionary defined. It must be
393- located on the same directory as
394- interoperability_report. This value should not contain
395- the extension ".py", only the name of the file. It
396- will run all the dictionaries defined in the file.
397- ( Default: test_suite) .
404+ located on the same directory as interoperability_report.
405+ This value should not contain the extension ".py", only
406+ the name of the file. It will run all the dictionaries
407+ defined in the file.
408+ Default: test_suite.
398409 -t test_cases [test_cases ...], --test test_cases [test_cases ...]
399410 Test Case that the script will run. This option is not
400411 supported with --disable-test. This allows to set
401- multiple values separated by a space. (Default: run
402- all Test Cases from the Test Suite.)
412+ multiple values separated by a space.
413+ Default: run all Test Cases from the Test Suite.
403414 -d test_cases_disabled [test_cases_disabled ...], --disable-test test_cases_disabled [test_cases_disabled ...]
404- Test Case that the script will skip. This allows to
405- set multiple values separated by a space. This option
406- is not supported with --test. (Default: None)
415+ Test Case that the script will skip. This allows to set
416+ multiple values separated by a space. This option is not
417+ supported with --test.
418+ Default: None
407419
408420output options:
409421 -o filename, --output-name filename
410422 Name of the xml report that will be generated. If the
411- file passed already exists, it will add the new
412- results to it. In other case it will create a new
413- file. (Default:
414- <publisher_name>-<subscriber_name>-date.xml)
423+ file passed already exists, it will add the new results
424+ to it. In other case it will create a new file.
425+ Default: <publisher_name>-<subscriber_name>-date.xml
415426```
416427
417428
0 commit comments