C3Fire

C3Fire Scenario Configuration

From C3LearningLabs
Revision as of 18:51, 31 July 2021 by Rego Granlund (talk | contribs) (Created page with "{{DISPLAYTITLE:C3Fire Scenario Configuration}} = Session Scenario Configuration = The scenario describes the dynamic characteristics of the session settings. It consists of...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


Session Scenario Configuration

The scenario describes the dynamic characteristics of the session settings. It consists of events that will effect the session at some
specified time.


Session scenario configuration file example

example.sce

<Scenario>
<Events>
  <Event Time = "00:00:00" Type = "SetTime"          Value = "02:15:00" />
  <Event Time = "02:15:00" Type = "SetWindDirection" Value = "90" />
  <Event Time = "02:15:00" Type = "SetWindSpeed"     Value = "3.0" />
  <Event Time = "02:15:00" Type = "StartFire"        Value = "5 5" />
  <Event Time = "02:15:00" Type = "StartFire"        Value = "5 6" />
  <Event Time = "02:15:00" Type = "StartFire"        Value = "6 5" />
  <Event Time = "02:15:00" Type = "StartFire"        Value = "6 6" />
  <Event Time = "02:15:10" Type = "SendMail"         Value = "DM:CX:Det_Brinner_i_6_6" />
  <Event Time = "02:15:30" Type = "Pause"            Value = " " />
  <Event Time = "02:16:00" Type = "End"              Value = " " />
</Events>
</Scenario>

XML Definition

Scenario

The xml file should contain the main element <Scenario> which should contain the element <Events>.

Events

Defines all Events that in the scenario.

Event

Defines the properties for an event.

Property

Value

Time

When the event should be activated.

Value example = "02:15:00"

Type

The type of the event.
See below for possible event types.

Value example = "SetTime"

Value

A value for the event

Value example = "02:15:00"


Possible Event types

The following events can be used.

Event Type

Value

SetTime

Set the simulation time.

Value example = "02:15:00"

SetWindDirection

Set the current wind direction.
0 = North
90 =
180 = South
270 =

Value example = "90"
For more information see the fire simulation documentation.

SetWindSpeed

Set the current wind speed.

Value example = "3.0"
For more information see the fire simulation documentation.

StartFire

Starts a new fire on a specified position.
The value specifies a (x,y) position on the map.

Value example = "6 5"

SendMail

Sends a mail from a simulated actor to some role.
The value specifies <Sender>:<Receiver>:<Mail>.

Value example = "DM:CX:It_is_Fire_at_pos_5_6"

Pause

Pause the session.

End

Ends the session.

Event types