Get the world name #1027
Merged
Get the world name #1027
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: ahcorde <[email protected]>
9 tasks
Codecov Report
@@ Coverage Diff @@
## main #1027 +/- ##
=======================================
Coverage 83.11% 83.12%
=======================================
Files 154 154
Lines 18685 18702 +17
=======================================
+ Hits 15530 15546 +16
- Misses 3155 3156 +1
Continue to review full report at Codecov.
|
chapulina
reviewed
May 23, 2022
| if(pworld) | ||
| { | ||
| _worldName = pworld->Attribute("name"); | ||
| } |
src/Root_TEST.cc
Outdated
| @@ -65,6 +66,16 @@ TEST(DOMRoot, MoveAssignmentOperator) | |||
| EXPECT_EQ("test_root", root2.Version()); | |||
| } | |||
|
|
|||
| TEST(DOMRoot, GetWorldName) | |||
There was a problem hiding this comment.
It would be interesting to test some failure cases
9 tasks
Signed-off-by: ahcorde <[email protected]>
azeey
reviewed
May 26, 2022
There was a problem hiding this comment.
In general, I have reservations about this approach because it doesn't go through the normal error checking process of the parser. It also results in loading the file into TinyXML twice, the second time when sdf::Root::Load is called.
Here are some other ideas to consider:
- Avoid the need for a world name in the first place. Maybe we can just use the global topic namespace for single worlds and have world-specific namespaces when we add support for multiple worlds. BTW, this implementation of
WorldNamedoesn't return all the world names in a file. What would be our plan when we want to add support for multiple worlds? - Generate a unique topic namespace for a given world during load (eg.
/world/UUID/topic/name) and then have some sort of topic and service remapping function in ign transport that maps/world/<world name>to/world/UUIDonce the world name is obtained from the fully loaded world. - Implement a partial parser in SDFormat where
includefiles are not processed. This would still suffer from the error checking issue I mentioned, but it wouldn't load the file twice.
include/sdf/Root.hh
Outdated
| /// \param[in] _filename Name of the SDF file to parse. | ||
| /// \param[out] _worldName The name of the world | ||
| /// \return Errors, which is a vector of Error objects. Each Error includes | ||
| /// an error code and message. An empty vector indicates no error. | ||
| public: Errors GetWorldName(const std::string &_filename, | ||
| std::string &_worldName); | ||
| public: Errors WorldName(const std::string &_filename, |
There was a problem hiding this comment.
Please rename this to WorldNameFromFile or something to indicate that this isn't returning a fully loaded world.
Signed-off-by: ahcorde <[email protected]>
azeey
approved these changes
Jun 30, 2022
| if(pworld) | ||
| { | ||
| _worldName = pworld->Attribute("name"); | ||
| } |
…rmat into ahcorde/root/worldname
scpeters
reviewed
Jul 8, 2022
Signed-off-by: ahcorde <[email protected]>
…rmat into ahcorde/root/worldname
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Signed-off-by: ahcorde [email protected]
🎉 New feature
Summary
Get just the world name instead of reading the whole file. This is required by this other PR gazebosim/gz-sim#1484
Checklist
codecheckpassed (See contributing)Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining
Signed-off-bymessages.