Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 2.24 KB

ChangeJointSpeeds.md

File metadata and controls

21 lines (15 loc) · 2.24 KB

class ChangeJointSpeeds

Member values

Member name Data type Description
joint_speeds JointSpeeds Joint speeds

Member functions

Function name Return type Input type Description
has_joint_speeds() const bool void Returns true if joint_speeds is set.
joint_speeds() const JointSpeeds& void Returns the current value of joint_speeds. If joint_speeds is not set, returns a JointSpeeds with none of its fields set (possibly joint_speeds::default_instance()).
mutable_joint_speeds() JointSpeeds * void Returns a pointer to the mutable JointSpeeds object that stores the field's value. If the field was not set prior to the call, then the returned JointSpeeds will have none of its fields set (i.e. it will be identical to a newly-allocated JointSpeeds). After calling this, has_joint_speeds() will return true and joint_speeds() will return a reference to the same instance of JointSpeeds.
clear_joint_speeds() void void Clears the value of the field. After calling this, has_joint_speeds() will return false and joint_speeds() will return the default value.
set_allocated_joint_speeds() void JointSpeeds * Sets the JointSpeeds object to the field and frees the previous field value if it exists. If the JointSpeeds pointer is not NULL, the message takes ownership of the allocated JointSpeeds object and has_ JointSpeeds() will return true. Otherwise, if the joint_speeds is NULL, the behavior is the same as calling clear_joint_speeds().
release_joint_speeds() JointSpeeds * void Releases the ownership of the field and returns the pointer of the JointSpeeds object. After calling this, caller takes the ownership of the allocated JointSpeeds object, has_joint_speeds() will return false, and joint_speeds() will return the default value.

Parent topic: Base (C++)