Skip to content

Commit 0ccc21b

Browse files
committed
Update new options from ShapeApplication in the README
1 parent 50d8949 commit 0ccc21b

File tree

1 file changed

+37
-4
lines changed

1 file changed

+37
-4
lines changed

README.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -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,7 +191,40 @@ 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]
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()
195228
196229
~~~
197230

0 commit comments

Comments
 (0)