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.actuator

io.github.srs.model.entity.dynamicentity.actuator

package io.github.srs.model.entity.dynamicentity.actuator

Members list

Packages

package io.github.srs.model.entity.dynamicentity.actuator.dsl

Type members

Classlikes

trait Actuator[E <: DynamicEntity]

Represents an actuator for a dynamic entity.

Represents an actuator for a dynamic entity.

Type parameters

E

the type of dynamic entity that the actuator can act upon.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DifferentialKinematics

DifferentialKinematics provides methods to compute the kinematics of a differential drive robot.

DifferentialKinematics provides methods to compute the kinematics of a differential drive robot.

It includes methods to compute wheel velocities, robot velocities, and the new position and orientation of the robot based on its current state and wheel speeds.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait DifferentialWheelMotor[E <: DynamicEntity] extends Actuator[E]

Actuator for differential wheel motors.

Actuator for differential wheel motors.

Type parameters

E

The type of dynamic entity this motor is associated with.

Attributes

Companion
object
Supertypes
trait Actuator[E]
class Object
trait Matchable
class Any
object DifferentialWheelMotor

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object DurationToDouble extends Conversion[FiniteDuration, Double]

Attributes

Supertypes
class Conversion[FiniteDuration, Double]
trait FiniteDuration => Double
class Object
trait Matchable
class Any
Self type
trait Kinematics[E <: DynamicEntity]

Provides kinematic operations for a dynamic entity.

Provides kinematic operations for a dynamic entity.

The kinematics typecast aims to decouple the kinematic operations from the specific dynamic entity implementations and reuse them across different entity types.

Type parameters

E

The type of the dynamic entity this kinematics instance operates on.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
final case class Wheel(speed: Double = ..., shape: Circle = ...)

Represents a wheel with linear speed and circular shape.

Represents a wheel with linear speed and circular shape.

Value parameters

shape

the physical shape of the wheel, assumed to be a circle.

speed

the linear speed of the wheel (in meters per second).

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object given_Kinematics_Agent extends Kinematics[Agent]

Provides kinematic operations for the Agent type.

Provides kinematic operations for the Agent type.

Attributes

Supertypes
trait Kinematics[Agent]
class Object
trait Matchable
class Any
Self type
object given_Kinematics_DynamicEntity extends Kinematics[DynamicEntity]

Provides kinematic operations for the general DynamicEntity type by delegating to the specific implementations

Provides kinematic operations for the general DynamicEntity type by delegating to the specific implementations

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object given_Kinematics_Robot extends Kinematics[Robot]

Provides kinematic operations for the Robot type.

Provides kinematic operations for the Robot type.

Attributes

Supertypes
trait Kinematics[Robot]
class Object
trait Matchable
class Any
Self type

Givens

Givens

given given_Kinematics_Agent: given_Kinematics_Agent

Provides kinematic operations for the Agent type.

Provides kinematic operations for the Agent type.

Attributes

given given_Kinematics_DynamicEntity: given_Kinematics_DynamicEntity

Provides kinematic operations for the general DynamicEntity type by delegating to the specific implementations

Provides kinematic operations for the general DynamicEntity type by delegating to the specific implementations

Attributes

given given_Kinematics_Robot: given_Kinematics_Robot

Provides kinematic operations for the Robot type.

Provides kinematic operations for the Robot type.

Attributes

Generated with