PPS-22-srs
API
Generated with
PPS-22-srs/io.github.srs/io.github.srs.model/io.github.srs.model.entity/io.github.srs.model.entity.dynamicentity/io.github.srs.model.entity.dynamicentity.action/MovementAction

MovementAction

io.github.srs.model.entity.dynamicentity.action.MovementAction
final case class MovementAction[F[_]] extends Action[F]

MovementAction represents a dynamic-entity movement action characterized by the speeds applied to the left and right wheels.

Type parameters

E

the type of dynamic entity on which the action is performed, extending DynamicEntity.

F

the effect type of the action.

Value parameters

leftSpeed

the speed to apply to the left wheel.

rightSpeed

the speed to apply to the right wheel.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Action[F]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def run[E <: DynamicEntity](dynamicEntity: E)(using a: ActionAlg[F, E]): F[E]

Runs the movement action using the provided ActionAlg.

Runs the movement action using the provided ActionAlg.

Value parameters

a

the ActionAlg to use for executing the movement action.

Attributes

Returns

an effectful computation that results in the dynamic entity after the wheels have been moved.

Definition Classes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with