@@ -169,15 +169,15 @@ The Shape application allows the following parameters:
169169
170170~~~
171171 --help, -h : print this menu
172+ -v [e|d] : set log message verbosity [e: ERROR, d: DEBUG]
172173 -P : publish samples
173174 -S : subscribe samples
174175 -d <int> : domain id (default: 0)
175176 -b : BEST_EFFORT reliability
176177 -r : RELIABLE reliability
177178 -k <depth> : keep history depth [0: KEEP_ALL]
178- -f <interval> : set a 'deadline' with interval (seconds) [0: OFF]
179- -i <interval> : apply 'time based filter' with interval (seconds) [0: OFF]
180- -s <int> : set ownership strength [-1: SHARED]
179+ -f <interval> : set a 'deadline' with interval (ms) [0: OFF]
180+ -s <strength> : set ownership strength [-1: SHARED]
181181 -t <topic_name> : set the topic name
182182 -c <color> : set color to publish (filter if subscriber)
183183 -p <partition> : set a 'partition' string
@@ -191,8 +191,42 @@ 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- -v [e|d] : set log message verbosity [e: ERROR, d: DEBUG]
195-
194+ --time-filter <interval> : apply 'time based filter' with interval
195+ in ms [0: OFF]
196+ --lifespan <int> : indicates the lifespan of a sample in ms
197+ --num-iterations <int>: indicates the number of iterations of the main loop
198+ After that, the application will exit.
199+ Default: infinite
200+ --num-instances <int>: indicates the number of instances a DataWriter writes
201+ If the value is > 1, the additional instances are
202+ created by appending a number. For example, if the
203+ original color is "BLUE" the instances used are
204+ "BLUE", "BLUE1", "BLUE2"...
205+ --num-topics <int>: indicates the number of topics created (using the same
206+ type). This also creates a DataReader or DataWriter per
207+ topic. If the value is > 1, the additional topic names
208+ are created by appending a number: For example, if the
209+ original topic name is "Square", the topics created are
210+ "Square", "Square1", "Square2"...
211+ --final-instance-state [u|d]: indicates the action performed after the
212+ DataWriter finishes its execution (before
213+ deleting it):
214+ - u: unregister
215+ - d: dispose
216+ --access-scope [i|t|g]: sets Presentation.access_scope to INSTANCE, TOPIC
217+ or GROUP
218+ --coherent : sets Presentation.coherent_access = true
219+ --ordered : sets Presentation.ordered_access = true
220+ --coherent-sample-count <int>: amount of samples sent for each DataWriter
221+ and instance that are grouped in a coherent
222+ set
223+ --additional-payload-size <bytes>: indicates the amount of bytes added to
224+ the samples written (for example to use
225+ large data)
226+ --take-read : uses take()/read() instead of take_next_instance()
227+ read_next_instance()
228+ --periodic-announcement <ms> : indicates the periodic participant
229+ announcement period in ms. Default 0 (off)
196230~~~
197231
198232## Return Code
@@ -323,62 +357,72 @@ The `interoperability_report.py` may configure the following options:
323357$ python3 interoperability_report.py -h
324358
325359usage: interoperability_report.py [-h] -P publisher_executable_name -S subscriber_executable_name
326- [-v] [-s test_suite_dictionary_file ]
327- [-t test_cases [test_cases ...] | -d
328- test_cases_disabled
329- [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]
330364
331- Validation of interoperability of products compliant with OMG DDS-RTPS
332- standard. This script generates automatically the verification between two
333- 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.
334368
335369optional arguments:
336370 -h, --help show this help message and exit
337371
338372general options:
339373 -P publisher_executable_name, --publisher publisher_executable_name
340- Path to the Publisher shape_main application. It may
341- be absolute or relative path. Example: if the
342- executable is in the same folder as the script: "-P
343- ./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".
344378 -S subscriber_executable_name, --subscriber subscriber_executable_name
345- Path to the Subscriber shape_main application. It may
346- be absolute or relative path. Example: if the
347- executable is in the same folder as the script: "-S
348- ./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".
349383
350384optional parameters:
351385 -v, --verbose Print debug information to stdout. This option also
352386 shows the shape_main application output in case of
353- error. If this option is not used, only the test
354- 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).
355399
356400Test Case and Test Suite:
357401 -s test_suite_dictionary_file, --suite test_suite_dictionary_file
358402 Test Suite that is going to be tested. Test Suite is a
359403 file with a Python dictionary defined. It must be
360- located on the same directory as
361- interoperability_report. This value should not contain
362- the extension ".py", only the name of the file. It
363- will run all the dictionaries defined in the file.
364- ( 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.
365409 -t test_cases [test_cases ...], --test test_cases [test_cases ...]
366410 Test Case that the script will run. This option is not
367411 supported with --disable-test. This allows to set
368- multiple values separated by a space. (Default: run
369- all Test Cases from the Test Suite.)
412+ multiple values separated by a space.
413+ Default: run all Test Cases from the Test Suite.
370414 -d test_cases_disabled [test_cases_disabled ...], --disable-test test_cases_disabled [test_cases_disabled ...]
371- Test Case that the script will skip. This allows to
372- set multiple values separated by a space. This option
373- 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
374419
375420output options:
376421 -o filename, --output-name filename
377422 Name of the xml report that will be generated. If the
378- file passed already exists, it will add the new
379- results to it. In other case it will create a new
380- file. (Default:
381- <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
382426```
383427
384428
0 commit comments