Side channel to send a goal to the environment. More...
Inheritance diagram for environment.sidechannels.goal_sc.GoalSC:
Public Member Functions | |
| None | __init__ (self) |
| The GoalSC class initializer. | |
| None | send_goal_position (self, Tuple[float] goal) |
| Send goal string to environment via side channel. More... | |
| None | on_message_received (self, IncomingMessage _) |
| Is called when the python side receives a message from the Unity environment. More... | |
Public Attributes | |
| goal_set | |
Detailed Description
Side channel to send a goal to the environment.
Member Function Documentation
◆ on_message_received()
| None environment.sidechannels.goal_sc.GoalSC.on_message_received | ( | self, | |
| IncomingMessage | _ | ||
| ) |
Is called when the python side receives a message from the Unity environment.
- Parameters
-
msg The message that is received in plain text.
◆ send_goal_position()
| None environment.sidechannels.goal_sc.GoalSC.send_goal_position | ( | self, | |
| Tuple[float] | goal | ||
| ) |
Send goal string to environment via side channel.
- Parameters
-
goal The goal to show.
The documentation for this class was generated from the following file:
- src/environment/sidechannels/goal_sc.py
