PPS-22-srs
API
Generated with
PPS-22-srs/io.github.srs

io.github.srs

package io.github.srs

Members list

Packages

package io.github.srs.config
package io.github.srs.controller
package io.github.srs.model
package io.github.srs.utils
package io.github.srs.view

Type members

Classlikes

final case class AppArgs(headless: Boolean, path: Option[String], simulationTime: Option[Long], seed: Option[Long])

Arguments for the application.

Arguments for the application.

Value parameters

headless

true if the application should run in headless mode (CLI), false for GUI mode.

path

the path to the configuration file.

seed

the seed for the random number generator.

simulationTime

the time to run the simulation for (in milliseconds).

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ArgParser

Command-line argument parser for the Scala Robotics Simulator application.

Command-line argument parser for the Scala Robotics Simulator application.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
ArgParser.type
trait BaseLauncher extends Interface[SimulationState], Interface[SimulationState], Interface[SimulationState]

Base trait for launching the Scala Robotics Simulator application.

Base trait for launching the Scala Robotics Simulator application.

It sets up the Model-View-Controller (MVC) architecture and provides a method to run the simulation.

The specific view implementation (GUI or CLI) is provided by the extending objects.

Attributes

Supertypes
class Object
trait Matchable
class Any
Show all
Known subtypes
object CLILauncher
object GUILauncher
object CLILauncher extends BaseLauncher, CLIComponent[SimulationState]

Launcher object for the CLI version of the Scala Robotics Simulator.

Launcher object for the CLI version of the Scala Robotics Simulator.

Attributes

Supertypes
trait BaseLauncher
class Object
trait Matchable
class Any
Show all
Self type
object GUILauncher extends BaseLauncher, GUIComponent[SimulationState]

Launcher object for the GUI version of the Scala Robotics Simulator.

Launcher object for the GUI version of the Scala Robotics Simulator.

Attributes

Supertypes
trait BaseLauncher
class Object
trait Matchable
class Any
Show all
Self type
final class main

Attributes

Supertypes
class Object
trait Matchable
class Any

Value members

Concrete methods

def main(args: String*): Unit
def mkInitialState(cfg: SimulationConfig[ValidEnvironment], headless: Boolean): SimulationState

Creates the initial state of the simulation based on the provided configuration.

Creates the initial state of the simulation based on the provided configuration.

Value parameters

cfg

the simulation configuration to use for initializing the state

Attributes

Returns

the initial state of the simulation

Generated with