O --- O
libPEDSIM Documentation
[HOME] [EXAMPLES] [ECOSYSTEM] [DOCUMENTATION] [DOWNLOAD]
O --- O
XML Messaging Format Specification

This is the message tags supported by libpedsim's outputwriter class.

Supported XML Tags

<reset>

A client receiving this tag should reset its internal state, so that output can begin (again).

Argument Description
n/a -

Example: <reset />

<timestep>

This tag indicates the start of a new timestep. The client should advance one frame.

Argument Description
value This is the number of the timestep. It does not have to be an integer necessarily, as long as it is sortable. E.g. 'A00001' is a possible value. However, in libpedsim it is defined as type long int.

Example: <timestep value="000001"/>

<position>

This tag is used to transmit the position of an object.

Argument Description
type 'agent', 'obstacle' and so on
id The id of the object
x The x co-ordinate of the object
y The y co-ordinate of the object

Example: <position type="agent" id="000001" x="25" y="-10" />

<remove>

This tag is used to remove an object.

Argument Description
type 'agent', 'obstacle' and so on
id The id of the object

Example: <remove type="agent" id="000001" />

<scenario>

This tag is used to transmit the start of a new scenario

Argument Description
name The name of the new scenarion. It may be printed on the putput device.

Example: <scenario name="Example 01" />

<draw>

This tag is used to render a graphic item on the output device.

Argument Description
type The type of the graphical item to render. E.g. "line"
sx The x co-ordinate of the start point (in case of a line)
sy The y co-ordinate of the start point (in case of a line)
ex (optional) The x co-ordinate of the end point (in case of a line)
ey (optional) The y co-ordinate of the end point (in case of a line)
duration How many timesteps the item will be displayed on the output device
red The red value of the item's color (0.0 .. 1.0)
green The green value of the item's color (0.0 .. 1.0)
blue The blue value of the item's color (0.0 .. 1.0)

Example: <draw type="line" sx="100" sy="100" ex="200" ey="200" duration="10" red="0.1" green="0.2" blue="1.0" />

<metrics>

This tag is used to transmit measured metrics

Argument Description
hash A keyword-value hash, string string

Example: <metrics> <metric key="name1" value="value1" /> <metric key="name2" value="value2" /> </metrics/>

O --- O

⁠(c) Christian Gloor [ c|h|g|l|o|o|r|@|s|i|l|m|a|r|i|l|.|o|r|g| ]