class ConstrainedJointAngle

August 13, 2019 ยท View on GitHub

Member values

Member nameData typeDescription
joint_identifieruint32Joint identifier (use device_identifier)
valuefloat32Joint value (in degrees)
constraintJointTrajectoryConstraintConstraint to apply to the joint angle (optional)

Member functions

Function nameReturn typeInput typeDescription
joint_identifier()uint32voidReturns the current value of joint_identifier. If the joint_identifier is not set, returns 0.
set_joint_identifier()voiduint32Sets the value of joint_identifier. After calling this, joint_identifier() will return value.
clear_joint_identifier()voidvoidClears the value of joint_identifier. After calling this, joint_identifier() will return 0.
value()float32voidReturns the current value of value. If the value is not set, returns 0.
set_value()voidfloat32Sets the value of value. After calling this, value() will return value.
clear_value()voidvoidClears the value of value. After calling this, value() will return 0.
has_constraint() constboolvoidReturns true if constraint is set.
constraint()const JointTrajectoryConstraint&voidReturns the current value of constraint. If constraint is not set, returns a JointTrajectoryConstraint with none of its fields set (possibly constraint::default_instance()).
mutable_constraint()JointTrajectoryConstraint *voidReturns a pointer to the mutable JointTrajectoryConstraint object that stores the field's value. If the field was not set prior to the call, then the returned JointTrajectoryConstraint will have none of its fields set (i.e. it will be identical to a newly-allocated JointTrajectoryConstraint). After calling this, has_constraint() will return true and constraint() will return a reference to the same instance of JointTrajectoryConstraint.
clear_constraint()voidvoidClears the value of the field. After calling this, has_constraint() will return false and constraint() will return the default value.
set_allocated_constraint()voidJointTrajectoryConstraint *Sets the JointTrajectoryConstraint object to the field and frees the previous field value if it exists. If the JointTrajectoryConstraint pointer is not NULL, the message takes ownership of the allocated JointTrajectoryConstraint object and has_ JointTrajectoryConstraint() will return true. Otherwise, if the constraint is NULL, the behavior is the same as calling clear_constraint().
release_constraint()JointTrajectoryConstraint *voidReleases the ownership of the field and returns the pointer of the JointTrajectoryConstraint object. After calling this, caller takes the ownership of the allocated JointTrajectoryConstraint object, has_constraint() will return false, and constraint() will return the default value.

Parent topic: Base (C++)