-
Notifications
You must be signed in to change notification settings - Fork 42
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.
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
Add GetTypeDescription.srv (rep2011) #153
Merged
clalancette
merged 9 commits into
ros2:rolling
from
emersonknapp:emersonknapp/type-description-distribution
Mar 23, 2023
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
2cbbd21
Add GetTypeDescription.srv
emersonknapp fb7a19c
Add format clarification comments and fix formatting
emersonknapp 6f8d286
Update service from design discussion
emersonknapp 71c97ae
Fix unfinished thought and clarify comments from review
emersonknapp 6756fdb
Type raw sources in a list of submessages
emersonknapp c5998a7
Use type_hash instead of type_version_hash
emersonknapp 2ec42ec
Update to cpp17 while we are here, like the rest of the pkgs in the repo
emersonknapp 1db9478
Update encoding information and resulting logical updates
emersonknapp a2b4f4e
Add better documentation for TypeSource
emersonknapp File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Represents an arbitrary key-value pair for application-specific information. | ||
|
||
string key | ||
string value |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Represents the original source of a ROS 2 interface definition. | ||
|
||
# ROS interface type name, in PACKAGE/NAMESPACE/TYPENAME format. | ||
string type_name | ||
|
||
# The type of the original source file, typically matching the file extension. | ||
# Well-known encodings: "idl", "msg", "srv", "action", "dynamic", "implicit". | ||
# "dynamic" specifies a type created programmatically by a user, thus having no source. | ||
# "implicit" specifies a type created automatically as a subtype of a | ||
# complex type (service or action) - such as the request message for a service. | ||
# Implicit types will have no contents, the full source will be available on the parent srv/action. | ||
string encoding | ||
|
||
# Dumped contents of the interface definition source file. | ||
# If `encoding` is "dynamic" or "implicit", this field will be empty. | ||
string raw_file_contents |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# ROS interface type name, in PACKAGE/NAMESPACE/TYPENAME format. | ||
string type_name | ||
|
||
# REP-2011 RIHS hash string. | ||
string type_hash | ||
|
||
# Whether to return the original idl/msg/etc. source file(s) in the response. | ||
bool include_type_sources true | ||
--- | ||
# True if the type description information is available and populated in the response. | ||
# If false, all other fields except `failure_reason` are considered undefined. | ||
bool successful | ||
# If `successful` is false, contains a reason for failure. | ||
# If `successful` is true, this is left empty. | ||
string failure_reason | ||
|
||
# The parsed type description which can be used programmatically. | ||
TypeDescription type_description | ||
|
||
# A list containing the interface definition source text of the requested type, | ||
# plus all types it recursively depends on. | ||
# Each source text is a copy of the original contents of the | ||
# .msg, .srv, .action, .idl, or other file if it exists, including comments and whitespace. | ||
# Sources can be matched with IndividualTypeDescriptions by their `type_name`. | ||
# The `encoding` field of each entry informs how to interpret its contents. | ||
TypeSource[] type_sources | ||
|
||
# Key-value pairs of extra information. | ||
KeyValue[] extra_information |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rename this to
reason
instead offailure_reason
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think something went wrong here, this became
failure_reason
again (1db9478)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that might have been intentional since it's no longer multi purpose? I'm not sure I haven't re-reviewed this yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct, changed back on purpose, see #153 (comment)