simulation.src.simulation_evaluation.src.state_machine.states.progress module

States used in the ProgressStateMachine.

Summary

Classes:

BeforeStart

This state is the default state.

Finished

This state occurs when the drive has finished.

Running

This state occurs when the drive has started.

Reference

class BeforeStart[source]

Bases: simulation.src.simulation_evaluation.src.state_machine.states.state.State

This state is the default state.

Once the state machine receives this state, the next state will we chage accordingly to its next method.

next(state_machine: simulation.src.simulation_evaluation.src.state_machine.state_machines.state_machine.StateMachine, input_msg: int)[source]

Next state.

Parameters
  • state_machine – On which state machine the states gets executed

  • input_msg – Integer of message

Returns

Class object of next state. If no state change was detected here, check for failure state before returning this state.

class Running[source]

Bases: simulation.src.simulation_evaluation.src.state_machine.states.state.State

This state occurs when the drive has started.

Once the state machine receives this state, the next state will we chage accordingly to its next method.

next(state_machine: simulation.src.simulation_evaluation.src.state_machine.state_machines.state_machine.StateMachine, input_msg: int)[source]

Next state.

Parameters
  • state_machine – On which state machine the states gets executed

  • input_msg – Integer of message

Returns

Class object of next state. If no state change was detected here, check for failure state before returning this state.

class Finished[source]

Bases: simulation.src.simulation_evaluation.src.state_machine.states.state.State

This state occurs when the drive has finished.

Once the state machine receives this state, the state can no longer change into a new one.

next(state_machine: simulation.src.simulation_evaluation.src.state_machine.state_machines.state_machine.StateMachine, input_msg: int)[source]

Next state.

Parameters
  • state_machine – On which state machine the states gets executed

  • input_msg – Integer of message

Returns

Class object of next state. If no state change was detected here, check for failure state before returning this state.