Skip to content

Commit

Permalink
docstring update for BackendFeature
Browse files Browse the repository at this point in the history
  • Loading branch information
yck011522 committed Oct 17, 2024
1 parent 3b7d121 commit ea51cd3
Showing 1 changed file with 6 additions and 17 deletions.
23 changes: 6 additions & 17 deletions src/compas_fab/backends/interfaces/backend_features.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ class BackendFeature(object):
Classes that inherit from this class are mixed-in when creating the planner backend interface.
Hence the the mixed-in class can access the attributes and other mix-ins functions of planner.
The implemented feature classes can assume that `self` is an instance of the planner backend interface.
IDE code completion and type hints can be activated by adding a line such as
`planner = self # type: MoveItPlanner`.
Attributes
----------
client : :class:`compas_fab.backends.interfaces.ClientInterface`
Expand Down Expand Up @@ -108,27 +112,12 @@ def _build_configuration(

return configuration

# @property
# def client(self):
# # type: () -> ClientInterface
# """Proxy function to access the backend client.
# This function should be overridden by the PlannerInterface default :meth:`PlannerInterface.client` or by the Planner.
# """
# raise NotImplementedError

# @property
# def robot_cell(self):
# # type: () -> RobotCell
# """Proxy function to access the RobotCell object.
# This function should be overridden by the PlannerInterface default :meth:`PlannerInterface.robot_cell` or by the Planner.
# """
# raise NotImplementedError


# The code that contains the actual feature implementation is located in the backend's module.
# For example, the features for moveit planner and ros client are located in :
# "src/compas_fab/backends/ros/backend_features/"
# If you cannot a specific feature in the 'backend_features', it means that the planner
# Only in the case of `inverse_kinematics` feature, the implementation for managing repeated calls is provided in this file.
# If you cannot find a specific feature in the 'backend_features', it means that the planner
# does not support that feature.


Expand Down

0 comments on commit ea51cd3

Please sign in to comment.