Merge pull request #1870 from LBNL-UCB-STI/rajnikantsh/#1868-state-um…

…l-design

add FSM UML

docs/uml/ChoosesModeFSM.puml

@@ -0,0 +1,24 @@
+@startuml
+
+scale 1000 width
+skinparam stateBorderColor #black
+skinparam stateFontStyle bold
+skinparam arrowColor #black
+
+' BeamAgent: States '
+state ChoosingMode #eb1921
+
+state FinishingModeChoice #eb1921
+
+'Transition State'
+
+FinishingModeChoice -[#blue,dotted]-> WaitingForDeparture : IntermediateTransition
+ChoosingMode --> ChoosingMode : MobilityStatusResponse
+ChoosingMode --> ChoosingMode : RoutingResponse
+ChoosingMode --> ChoosingMode : RideHailResponse
+ChoosingMode --> ChoosingMode : ParkingInquiryResponse
+ChoosingMode --> ChoosingMode : CavTripLegsResponse
+ChoosingMode --> FinishingModeChoice
+
+
+@enduml

docs/uml/ChoosesParkingFSM.puml

@@ -0,0 +1,20 @@
+@startuml
+
+scale 1000 width
+skinparam stateBorderColor #black
+skinparam stateFontStyle bold
+skinparam arrowColor #black
+
+' BeamAgent: States '
+state ReleasingParkingSpot #eb1921
+
+state ChoosingParkingSpot #eb1921
+
+'Transition State'
+ReleasingParkingSpot --> ReleasingParkingSpot: StartLegTrigger
+ReleasingParkingSpot -[#blue,dotted]-> WaitingToDrive: IntermediateTransition
+ChoosingParkingSpot --> ChoosingParkingSpot : ParkingInquiryResponse
+ChoosingParkingSpot --> WaitingToDrive : RoutingResponse
+
+
+@enduml

docs/uml/DrivesVehicle.puml

@@ -0,0 +1,38 @@
+@startuml
+
+scale 1000 width
+scale 700 height
+skinparam stateBorderColor #black
+skinparam stateFontStyle bold
+skinparam arrowColor #black
+
+' BeamAgent: States '
+state Driving #eb1921
+
+state DrivingInterrupted #eb1921
+
+state WaitingToDrive #eb1921
+
+state WaitingToDriveInterrupted #eb1921
+
+
+'BeamAgent Transitions'
+Driving ---> ReadyToChooseParking : (EndLegTrigger,LiterallyDrivingData)
+Driving ---> WaitingToDrive : (EndLegTrigger,LiterallyDrivingData)
+Driving ---> PassengerScheduleEmpty :(EndLegTrigger,LiterallyDrivingData)
+Driving ---> Driving : EndLegTrigger,StopDrivingIfNoPassengerOnBoard
+Driving ---> DrivingInterrupted : Interrupt,StopDrivingIfNoPassengerOnBoard
+
+DrivingInterrupted ---> PassengerScheduleEmptyInterrupted : (StopDriving,LiterallyDrivingData)
+DrivingInterrupted ---> Driving : Resume
+DrivingInterrupted ---> DrivingInterrupted : EndLegTrigger,Interrupt
+
+WaitingToDrive ---> Driving : StartLegTrigger
+WaitingToDrive ---> WaitingToDrive : Interrupt,NotifyVehicleResourceIdleReply,StopDrivingIfNoPassengerOnBoard
+WaitingToDrive ---> DrivingInterrupted : StopDrivingIfNoPassengerOnBoard
+
+
+WaitingToDriveInterrupted ---> Driving : Resume
+WaitingToDriveInterrupted ---> WaitingToDriveInterrupted : TriggerWithId
+
+@enduml

docs/uml/HouseholdFSM.puml

@@ -0,0 +1,25 @@
+@startuml
+
+scale 1000 width
+skinparam stateBorderColor #black
+skinparam stateFontStyle bold
+skinparam arrowColor #black
+
+' BeamAgent: States '
+state Uninitialized #gray
+
+state Idle #eb1921
+
+state PassengerScheduleEmpty #eb1921
+
+'Transition State'
+
+[*] --> Uninitialized
+Uninitialized --> Idle: InitializeTrigger
+Idle --> WaitingToDrive: ModifyPassengerSchedule
+PassengerScheduleEmpty --> PassengerScheduleEmpty: PassengerScheduleEmptyMessage
+PassengerScheduleEmpty --> Idle: Success
+PassengerScheduleEmpty --> [*]: KillTrigger
+
+
+@enduml

docs/uml/PersonAgent.puml

@@ -0,0 +1,76 @@
+@startuml
+
+scale 1000 width
+scale 800 height
+skinparam stateBorderColor #black
+skinparam stateFontStyle bold
+skinparam arrowColor #black
+
+' BeamAgent: States '
+state Uninitialized #grey
+
+state Initialized #grey
+
+state PerformingActivity #eb1921
+
+state WaitingForDeparture #eb1921
+
+state WaitingForReservationConfirmation #eb1921
+
+state Waiting #eb1921
+
+state Moving #eb1921
+
+state PassengerScheduleEmpty #eb1921
+
+state ReadyToChooseParking #eb1921
+
+state TryingToBoardVehicle #eb1921
+
+state ProcessingNextLegOrStartActivity #eb1921
+
+'BeamAgent Transitions'
+[*] --> Uninitialized
+Uninitialized --> Initialized :InitializeTrigger
+
+Initialized --> PerformingActivity : ActivityStartTrigger
+
+
+PerformingActivity --> ChoosingMode : ActivityEndTrigger
+PerformingActivity --> [*] : ActivityEndTrigger
+
+WaitingForDeparture --> ProcessingNextLegOrStartActivity : PersonDepartureTrigger
+
+WaitingForReservationConfirmation --> Waiting : ReservationResponse
+WaitingForReservationConfirmation --> ChoosingMode : ReservationResponse(error)
+WaitingForReservationConfirmation --> WaitingForReservationConfirmation : DelayedRideHailResponse
+WaitingForReservationConfirmation --> ChoosingMode : RideHailResponseTrigger(error)
+WaitingForReservationConfirmation --> Waiting : RideHailResponse
+WaitingForReservationConfirmation --> ChoosingMode : RideHailResponse(error)
+
+Waiting --> Moving : BoardVehicleTrigger
+
+Moving --> ProcessingNextLegOrStartActivity : AlightVehicleTrigger
+
+PassengerScheduleEmpty --> ProcessingNextLegOrStartActivity: PassengerScheduleEmptyMessage
+
+ReadyToChooseParking -[#blue,dotted]-> ChoosingParkingSpot: IntermediateTransition
+
+TryingToBoardVehicle --> ProcessingNextLegOrStartActivity : Boarded
+TryingToBoardVehicle --> ChoosingMode : NotAvailable
+
+
+ProcessingNextLegOrStartActivity --> ReleasingParkingSpot : ProcessingNextLegOrStartActivity
+ProcessingNextLegOrStartActivity --> WaitingToDrive : ProcessingNextLegOrStartActivity
+ProcessingNextLegOrStartActivity -[#blue,dotted]-> ChoosingMode : IntermediateTransition
+ProcessingNextLegOrStartActivity -[#blue,dotted]-> WaitingForReservationConfirmation : IntermediateTransition
+ProcessingNextLegOrStartActivity -[#blue,dotted]-> Waiting : IntermediateTransition
+ProcessingNextLegOrStartActivity -[#blue,dotted]-> PerformingActivity : IntermediateTransition
+'[*] is stop event'
+ProcessingNextLegOrStartActivity -[#blue,dotted]-> [*] : IntermediateTransition
+
+
+
+
+
+@enduml

docs/uml/RideHailAgentFSM.puml

@@ -0,0 +1,46 @@
+@startuml
+
+scale 1000 width
+scale 700 height
+skinparam stateBorderColor #black
+skinparam stateFontStyle bold
+skinparam arrowColor #black
+
+' BeamAgent: States '
+state Uninitialized #grey
+
+state Idle #eb1921
+
+state Offline #eb1921
+
+state IdleInterrupted #eb1921
+
+state PassengerScheduleEmpty #eb1921
+
+state PassengerScheduleEmptyInterrupted  #eb1921
+
+
+'BeamAgent Transitions'
+[*] --> Uninitialized
+Uninitialized --> Idle : InitializeTrigger
+Uninitialized --> Offline : InitializeTrigger
+
+Offline --> Idle: StartShiftTrigger
+Offline --> Offline : Interrupt,NotifyVehicleResourceIdleReply,StartRefuelTrigger,EndRefuelTrigger
+
+Idle --> Offline: EndShiftTrigger
+Idle --> Idle: NotifyVehicleResourceIdleReply,EndRefuelTrigger,StartRefuelTrigger
+Idle --> IdleInterrupted: Interrupt
+
+IdleInterrupted --> Idle : Resume
+IdleInterrupted --> IdleInterrupted : Interrupt,NotifyVehicleResourceIdleReply
+IdleInterrupted --> WaitingToDriveInterrupted : ModifyPassengerSchedule
+
+PassengerScheduleEmpty --> Idle : PassengerScheduleEmptyMessage
+PassengerScheduleEmpty --> PassengerScheduleEmpty: Interrupt
+
+PassengerScheduleEmptyInterrupted --> IdleInterrupted : PassengerScheduleEmptyMessage
+PassengerScheduleEmptyInterrupted --> PassengerScheduleEmptyInterrupted : ModifyPassengerSchedule,Resume,Interrupt
+
+
+@enduml

docs/uml/TransistDriverFSM.puml

@@ -0,0 +1,20 @@
+@startuml
+
+scale 1000 width
+skinparam stateBorderColor #black
+skinparam stateFontStyle bold
+skinparam arrowColor #black
+
+state Uninitialized #gray
+
+state PassengerScheduleEmpty  #eb1921
+
+
+[*] --> Uninitialized
+Uninitialized --> WaitingToDrive : InitializeTrigger
+
+PassengerScheduleEmpty --> PassengerScheduleEmpty : PassengerScheduleEmptyMessage
+PassengerScheduleEmpty --> [*] : KillTrigger
+
+
+@enduml