Sequence Configuration

If you want to start more than one c3fire session in a training or experiment series, you can use the session management. The session management is based on definitions of sequences of sessions. A sequence of sessions is defined in a xml file that describes all configuration for all sessions that belong to the sequence.


Sequence configuration file example

example.seq
==================================================
<Sequence>

  <SequenceConfiguration 
    Name = "XY" />
   
  <Sessions>
  
    <Session>
      <SessionConfiguration
        Number = "1"
        Name = "Try" 
        ManagerWindowMinimized = "True"
        AutoMangerReadyConfirm = "True"
        AutoStart = "True"
        AutoExit = "True"
        ConfigurationFilePathAndName  = "C:/c3fire/SessionDef/SessionConfig/xy.con"
        ScenarioFilePathAndName       = "C:/c3fire/SessionDef/SessionScenario/dev.sce"
        MapImageFilePathAndName       = "C:/c3fire/SessionDef/SessionMapImage/dev.gif" />
    </Session>
    
    <Session>
      <SessionConfiguration
        Number = "2"
        Name = "Session 1" 
        ManagerWindowMinimized = "True"
        AutoMangerReadyConfirm = "True"
        AutoStart = "True"
        AutoExit = "True"
        ConfigurationFilePathAndName  = "C:/c3fire/SessionDef/SessionConfig/xy.con"
        ScenarioFilePathAndName       = "C:/c3fire/SessionDef/SessionScenario/dev.sce"
        MapImageFilePathAndName       = "C:/c3fire/SessionDef/SessionMapImage/dev.gif" />   
    </Session>

    <Session>
      <SessionConfiguration
        Number = "3"
        Name = "Session 2" 
        ManagerWindowMinimized = "True"
        AutoMangerReadyConfirm = "True"
        AutoStart = "True"
        AutoExit = "True"     
        ConfigurationFilePathAndName  = "C:/c3fire/SessionDef/SessionConfig/xy.con"
        ScenarioFilePathAndName       = "C:/c3fire/SessionDef/SessionScenario/dev.sce"
        MapImageFilePathAndName       = "C:/c3fire/SessionDef/SessionMapImage/dev.gif" />
    </Session>

    <Session>
      <SessionConfiguration
        Number = "4"
        Name = "Session 3" 
        ManagerWindowMinimized = "True"
        AutoMangerReadyConfirm = "True"
        AutoStart = "True"
        AutoExit = "True"        
        ConfigurationFilePathAndName  = "C:/c3fire/SessionDef/SessionConfig/xy.con"
        ScenarioFilePathAndName       = "C:/c3fire/SessionDef/SessionScenario/dev.sce"
        MapImageFilePathAndName       = "C:/c3fire/SessionDef/SessionMapImage/dev.gif" /> 
    </Session>
   
  </Sessions>
  
</Sequence>
==================================================

XML Definition

The main element in the xml file is <Sequence>, it should have the elements <SequenceConfiguration> and <Sessions>. The <Sessions> element should contain a set of <Session> elements.


Sequence

The main element that contains all the information in the sequence configuration file.


SequenceConfiguration

Property

Value

Name

The name of the sequence configuration. This name is used as a default sequence name when the user starts a new sequence.
Value example = "seq1"



Sessions

The Sessions element should contain a set of Session elements.


Session

Information about a session.

SessionConfiguration

The information that defines the configuration of a session in a sequence.

Property

Value

Number

The sessions number in the sequence.

Value example = "1"

Name

The name of the session in the sequence.

Value example = "Session 1"

ManagerWindowMinimized

If the manager session control window should be minimized when the new session is started.

Possible values = "True", "False"

AutoMangerReadyConfirm

Makes the manager to be automatically ready to start a new session.
If true then the session starts when all players has pressed their ready button.

Possible values = "True", "False"

AutoStart

If the system automatically should start a session when the session is ready to be started. If true then the manager does not need to press at the start button to start the session.

Possible values = "True", "False"

AutoExit

If the system automatically should exit a session when the session has ended. If true then the manager does not need to press at the exit button.

Possible values = "True", "False"

ConfigurationFilePathAndName

The session configuration file.

Value example = "C:\c3fire\SessionDef\SessionConfig\session1.con"

ScenarioFilePathAndName

The session scenario file.

Value example = "C:\c3fire\SessionDef\SessionScenario\session1.sce"

MapImageFilePathAndName

The map image file.

Value example = "C:\c3fire\SessionDef\SessionMapImage\session1.gif"