Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc and format fixes #135

Merged
merged 5 commits into from
Jul 31, 2024
Merged

Doc and format fixes #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7ceb1c0
add missing libs and correct dead links in overview table in
fmirus Jul 31, 2024
1f14cc5
format fixes
fmirus Jul 31, 2024
80e9310
repo link fix
fmirus Jul 31, 2024
5e9d2e9
Merge branch 'main' into doc_fixes
fmirus Jul 31, 2024
4c0476b
Merge branch 'main' into doc_fixes
fmirus Jul 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/libraries.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,20 @@ Beside ``osc.standard`` provided by OpenSCENARIO 2 (which we divide into ``osc.s
- Robotics Library (provided with :repo_link:`scenario_execution`)
* - ``osc.ros``
- ROS Library (provided with :repo_link:`scenario_execution_ros`)
* - ``osc.nav2``
- ROS Nav2 navigation stack Library (provided with :repo_link:`libs/scenario_execution_nav2`)
* - ``osc.os``
- Library to interact with the operating system (provided with :repo_link:`libs/scenario_execution_os`)
* - ``osc.gazebo``
- Gazebo Library (provided with :repo_link:`scenario_execution_gazebo`)
- Gazebo Library (provided with :repo_link:`libs/scenario_execution_gazebo`)

Additional features can be implemented by defining your own library.


Gazebo
------

The library contains actions to interact with the `Gazebo Simulation <https://gazebosim.org/>`_. Import it with ``import osc.gazebo``. It's provided by the package :repo_link:`scenario_execution_gazebo`.
The library contains actions to interact with the `Gazebo Simulation <https://gazebosim.org/>`_. Import it with ``import osc.gazebo``. It's provided by the package :repo_link:`libs/scenario_execution_gazebo`.

Actions
^^^^^^^
Expand Down
20 changes: 10 additions & 10 deletions scenario_execution/scenario_execution/osc2_parsing/OpenSCENARIO2Parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2179,7 +2179,7 @@ def siBaseUnitName(self):
self.enterOuterAlt(localctx, 1)
self.state = 397
_la = self._input.LA(1)
if not((((_la) & ~0x3f) == 0 and ((1 << _la) & ((1 << OpenSCENARIO2Parser.T__11) | (1 << OpenSCENARIO2Parser.T__12) | (1 << OpenSCENARIO2Parser.T__13) | (1 << OpenSCENARIO2Parser.T__14) | (1 << OpenSCENARIO2Parser.T__15) | (1 << OpenSCENARIO2Parser.T__16) | (1 << OpenSCENARIO2Parser.T__17) | (1 << OpenSCENARIO2Parser.T__18))) != 0)):
if not ((((_la) & ~0x3f) == 0 and ((1 << _la) & ((1 << OpenSCENARIO2Parser.T__11) | (1 << OpenSCENARIO2Parser.T__12) | (1 << OpenSCENARIO2Parser.T__13) | (1 << OpenSCENARIO2Parser.T__14) | (1 << OpenSCENARIO2Parser.T__15) | (1 << OpenSCENARIO2Parser.T__16) | (1 << OpenSCENARIO2Parser.T__17) | (1 << OpenSCENARIO2Parser.T__18))) != 0)):
self._errHandler.recoverInline(self)
else:
self._errHandler.reportMatch(self)
Expand Down Expand Up @@ -2370,7 +2370,7 @@ def enumMemberValue(self):
self.enterOuterAlt(localctx, 1)
self.state = 419
_la = self._input.LA(1)
if not(_la == OpenSCENARIO2Parser.UintLiteral or _la == OpenSCENARIO2Parser.HexUintLiteral):
if not (_la == OpenSCENARIO2Parser.UintLiteral or _la == OpenSCENARIO2Parser.HexUintLiteral):
self._errHandler.recoverInline(self)
else:
self._errHandler.reportMatch(self)
Expand Down Expand Up @@ -4618,7 +4618,7 @@ def primitiveType(self):
self.enterOuterAlt(localctx, 1)
self.state = 670
_la = self._input.LA(1)
if not((((_la) & ~0x3f) == 0 and ((1 << _la) & ((1 << OpenSCENARIO2Parser.T__32) | (1 << OpenSCENARIO2Parser.T__33) | (1 << OpenSCENARIO2Parser.T__34) | (1 << OpenSCENARIO2Parser.T__35) | (1 << OpenSCENARIO2Parser.T__36))) != 0)):
if not ((((_la) & ~0x3f) == 0 and ((1 << _la) & ((1 << OpenSCENARIO2Parser.T__32) | (1 << OpenSCENARIO2Parser.T__33) | (1 << OpenSCENARIO2Parser.T__34) | (1 << OpenSCENARIO2Parser.T__35) | (1 << OpenSCENARIO2Parser.T__36))) != 0)):
self._errHandler.recoverInline(self)
else:
self._errHandler.reportMatch(self)
Expand Down Expand Up @@ -5378,7 +5378,7 @@ def everyExpression(self):
localctx._Identifier = self.match(OpenSCENARIO2Parser.Identifier)

offsetName = (None if localctx._Identifier is None else localctx._Identifier.text)
if(not (offsetName == "offset")):
if (not (offsetName == "offset")):
print("%s must be offset" % offsetName)
raise NoViableAltException(self)

Expand Down Expand Up @@ -6155,7 +6155,7 @@ def constraintQualifier(self):
self.enterOuterAlt(localctx, 1)
self.state = 837
_la = self._input.LA(1)
if not(_la == OpenSCENARIO2Parser.T__49 or _la == OpenSCENARIO2Parser.T__50):
if not (_la == OpenSCENARIO2Parser.T__49 or _la == OpenSCENARIO2Parser.T__50):
self._errHandler.recoverInline(self)
else:
self._errHandler.reportMatch(self)
Expand Down Expand Up @@ -6956,7 +6956,7 @@ def compositionOperator(self):
self.enterOuterAlt(localctx, 1)
self.state = 927
_la = self._input.LA(1)
if not((((_la) & ~0x3f) == 0 and ((1 << _la) & ((1 << OpenSCENARIO2Parser.T__54) | (1 << OpenSCENARIO2Parser.T__55) | (1 << OpenSCENARIO2Parser.T__56))) != 0)):
if not ((((_la) & ~0x3f) == 0 and ((1 << _la) & ((1 << OpenSCENARIO2Parser.T__54) | (1 << OpenSCENARIO2Parser.T__55) | (1 << OpenSCENARIO2Parser.T__56))) != 0)):
self._errHandler.recoverInline(self)
else:
self._errHandler.reportMatch(self)
Expand Down Expand Up @@ -8897,7 +8897,7 @@ def relationalOp(self):
self.enterOuterAlt(localctx, 1)
self.state = 1139
_la = self._input.LA(1)
if not(((((_la - 23)) & ~0x3f) == 0 and ((1 << (_la - 23)) & ((1 << (OpenSCENARIO2Parser.T__22 - 23)) | (1 << (OpenSCENARIO2Parser.T__75 - 23)) | (1 << (OpenSCENARIO2Parser.T__76 - 23)) | (1 << (OpenSCENARIO2Parser.T__77 - 23)) | (1 << (OpenSCENARIO2Parser.T__78 - 23)) | (1 << (OpenSCENARIO2Parser.T__79 - 23)) | (1 << (OpenSCENARIO2Parser.T__80 - 23)))) != 0)):
if not (((((_la - 23)) & ~0x3f) == 0 and ((1 << (_la - 23)) & ((1 << (OpenSCENARIO2Parser.T__22 - 23)) | (1 << (OpenSCENARIO2Parser.T__75 - 23)) | (1 << (OpenSCENARIO2Parser.T__76 - 23)) | (1 << (OpenSCENARIO2Parser.T__77 - 23)) | (1 << (OpenSCENARIO2Parser.T__78 - 23)) | (1 << (OpenSCENARIO2Parser.T__79 - 23)) | (1 << (OpenSCENARIO2Parser.T__80 - 23)))) != 0)):
self._errHandler.recoverInline(self)
else:
self._errHandler.reportMatch(self)
Expand Down Expand Up @@ -9055,7 +9055,7 @@ def additiveOp(self):
self.enterOuterAlt(localctx, 1)
self.state = 1153
_la = self._input.LA(1)
if not(_la == OpenSCENARIO2Parser.T__81 or _la == OpenSCENARIO2Parser.T__82):
if not (_la == OpenSCENARIO2Parser.T__81 or _la == OpenSCENARIO2Parser.T__82):
self._errHandler.recoverInline(self)
else:
self._errHandler.reportMatch(self)
Expand Down Expand Up @@ -9213,7 +9213,7 @@ def multiplicativeOp(self):
self.enterOuterAlt(localctx, 1)
self.state = 1167
_la = self._input.LA(1)
if not(((((_la - 84)) & ~0x3f) == 0 and ((1 << (_la - 84)) & ((1 << (OpenSCENARIO2Parser.T__83 - 84)) | (1 << (OpenSCENARIO2Parser.T__84 - 84)) | (1 << (OpenSCENARIO2Parser.T__85 - 84)))) != 0)):
if not (((((_la - 84)) & ~0x3f) == 0 and ((1 << (_la - 84)) & ((1 << (OpenSCENARIO2Parser.T__83 - 84)) | (1 << (OpenSCENARIO2Parser.T__84 - 84)) | (1 << (OpenSCENARIO2Parser.T__85 - 84)))) != 0)):
self._errHandler.recoverInline(self)
else:
self._errHandler.reportMatch(self)
Expand Down Expand Up @@ -10544,7 +10544,7 @@ def integerLiteral(self):
self.enterOuterAlt(localctx, 1)
self.state = 1324
_la = self._input.LA(1)
if not(((((_la - 99)) & ~0x3f) == 0 and ((1 << (_la - 99)) & ((1 << (OpenSCENARIO2Parser.UintLiteral - 99)) | (1 << (OpenSCENARIO2Parser.HexUintLiteral - 99)) | (1 << (OpenSCENARIO2Parser.IntLiteral - 99)))) != 0)):
if not (((((_la - 99)) & ~0x3f) == 0 and ((1 << (_la - 99)) & ((1 << (OpenSCENARIO2Parser.UintLiteral - 99)) | (1 << (OpenSCENARIO2Parser.HexUintLiteral - 99)) | (1 << (OpenSCENARIO2Parser.IntLiteral - 99)))) != 0)):
self._errHandler.recoverInline(self)
else:
self._errHandler.reportMatch(self)
Expand Down
2 changes: 1 addition & 1 deletion scenario_execution/setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
this_directory = Path(__file__).parent
try:
LONG_DESCRIPTION = (this_directory / "README.md").read_text()
except: # pylint: disable=W0702
except: # pylint: disable=W0702
# in case we do colcon build --symlink-install, wo do not need the
# description
LONG_DESCRIPTION = ''
Expand Down