Skip to content
Open
Changes from all commits
Commits
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
52 changes: 52 additions & 0 deletions proto/gz/msgs/dynamic_detachable_joint.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/*
* Copyright (C) 2025 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// Contributor: Adarsh Karan K P
// Neobotix GmbH

syntax = "proto3";

package gz.msgs;

option java_package = "com.gz.msgs";
option java_outer_classname = "DynamicDetachableJointProtos";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we move the AttachDetachResponse to Result, this will just be AttachDetachRequest


/// \ingroup gz.msgs
/// \interface DynamicDetachableJoint
/// \brief Message for dynamic detachable joint

import "gz/msgs/header.proto";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The header is imported here, but it's not being used.


message AttachDetachRequest
{
/// \brief Name of the child model
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add header here?

string child_model_name = 1;

/// \brief Name of the child link
string child_link_name = 2;

/// \brief Command to attach or detach
string command = 3;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since there is a limited list of commands here, I suggest we change this to an enum, see

.

}

message AttachDetachResponse
{
/// \brief True if the operation was successful
bool success = 1;

/// \brief Additional message or error description
string message = 2;
}
Comment on lines +45 to +52
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like it could be a generic Result type. How about:

in proto/gz/msgs/result.proto

message Result
{
  /// \brief 0 if the operation was successful
  int error_code = 1;
  /// \brief Additional message or error description
  string message = 2;
}

Loading