File tree Expand file tree Collapse file tree 1 file changed +21
-4
lines changed
Expand file tree Collapse file tree 1 file changed +21
-4
lines changed Original file line number Diff line number Diff line change @@ -24,17 +24,34 @@ option java_outer_classname = "WheelSlipParametersCmd";
2424/// \interface WheelSlipParametersCmd
2525/// \brief Message containing a wheel slip parameters user command.
2626
27+ import "ignition/msgs/entity.proto" ;
2728import "ignition/msgs/header.proto" ;
2829
2930message WheelSlipParametersCmd
3031{
3132 /// \brief Optional header data
3233 Header header = 1 ;
3334
34- /// \brief Name of the model we want to modify the wheel slip parameters.
35- string model_name = 2 ;
36- /// \brief Name of the model's link to apply the wheel slip parameters.
37- string link_name = 3 ;
35+ /// \brief Entity which wheel slip parameters are going to be modified.
36+ ///
37+ /// The entity might be a model with at least one link or a link.
38+ /// If the entity is a model, the wheel slip parameters of all its
39+ /// links will be updated.
40+ ///
41+ /// The entity name (entity.name) will be used as an scoped name.
42+ /// For example, in this
43+ /// hierarchy:
44+ ///
45+ /// world_name
46+ /// model_name
47+ /// link_name
48+ ///
49+ /// All these names will return the link entity:
50+ ///
51+ /// * world_name::model_name::link_name
52+ /// * model_name::link_name
53+ /// * link_name
54+ Entity entity = 2 ;
3855
3956 /// \brief Unitless lateral slip ratio.
4057 ///
You can’t perform that action at this time.
0 commit comments