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

io.github.srs.model

package io.github.srs.model

Members list

Packages

package io.github.srs.model.dsl
package io.github.srs.model.entity
package io.github.srs.model.environment
package io.github.srs.model.illumination
package io.github.srs.model.logic
package io.github.srs.model.validation

Type members

Classlikes

object ModelModule

Module that defines the model logic for the Scala Robotics Simulator.

Module that defines the model logic for the Scala Robotics Simulator.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final case class Simulation(duration: Option[Long], seed: Option[Long])

Simulation configuration. It contains the information needed to start a simulation.

Simulation configuration. It contains the information needed to start a simulation.

Value parameters

duration

The duration of the simulation in ticks. If None, the simulation will run indefinitely.

seed

The seed for the random number generator. If None, a random seed will be used.

Attributes

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

Simulation companion object. It provides a dsl for creating and configuring a simulation.

Simulation companion object. It provides a dsl for creating and configuring a simulation.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Simulation.type
object SimulationConfig

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final case class SimulationState(simulationTime: Option[FiniteDuration], elapsedTime: FiniteDuration, dt: FiniteDuration, simulationSpeed: SimulationSpeed, simulationRNG: RNG, simulationStatus: SimulationStatus, environment: ValidEnvironment) extends State

Simulation state case class that holds the current state of the simulation.

Simulation state case class that holds the current state of the simulation.

Value parameters

dt

the time step for each simulation update.

elapsedTime

the elapsed time since the start of the simulation.

environment

the current environment of the simulation.

simulationRNG

the random number generator used in the simulation.

simulationSpeed

the speed at which the simulation is running.

simulationStatus

the current status of the simulation.

simulationTime

the current simulation time, if applicable.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait State
class Object
trait Matchable
class Any
Show all
object SimulationState

Companion methods for the ModelModule.State to provide pretty-printing functionality.

Companion methods for the ModelModule.State to provide pretty-printing functionality.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Generated with