Introduce ScenarI/O abstract classes #219
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces real abstract classes implementing the ScenarI/O APIs. These new classes are basically a generalized version of the Ignition Gazebo backend (#158), where only the methods that could be compatible with other future backends (e.g. YARP, ROS, etc) have been kept.
This abstraction should help writing generic code that works with any backend. The concrete class initialization and the calls to custom methods not part of the interface should be kept isolated from the generic code (e.g. the classes implementing
gym_ignition.task.Task
in Python), and should be put in other components like the task randomizer (#177).📝 The interfaces are finally documented. There are few classes still without documentation, however the major ones are there.
❗ this is part of a multi-PR feature and tests will not pass yet. Have a look at #220 for the bigger picture.