Skip to content

Commit

Permalink
goto_based_part class desc
Browse files Browse the repository at this point in the history
  • Loading branch information
glannuzel committed Oct 10, 2024
1 parent da414a5 commit c60f40b
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions src/reachy2_sdk/parts/goto_based_part.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,16 @@


class IGoToBasedPart(ABC):
"""The IGoToBasedPart class is an interface to define default behavior of all parts using goto functions.
"""Interface for parts of Reachy that use goto functions.
This interface is meant to be implemented by any relevant part of the robot : Arm, Head, (MobileBase in the future)
The `IGoToBasedPart` class defines a common interface for handling goto-based movements. It is
designed to be implemented by parts of the robot that perform movements via the goto mechanism,
such as the Arm, Head, or potentially the MobileBase in the future.
Methods:
get_goto_playing: Retrieve the currently playing goto command for a specific part.
get_goto_queue: Get a list of all queued goto commands for the part.
cancel_all_goto: Cancel all active and pending goto commands for the part.
"""

def __init__(
Expand Down

0 comments on commit c60f40b

Please sign in to comment.