class GripperCommand
August 13, 2019 ยท View on GitHub
Member values
| Member name | Data type | Description |
|---|---|---|
| mode | uint32 | Mode in which to control the gripper |
| gripper | Gripper | Gripper movement values |
| duration | uint32 | Duration constraint. If not 0, allows to set a limit (in seconds) to the GripperCommand |
Member functions
| Function name | Return type | Input type | Description |
|---|---|---|---|
| mode() const | uint32 | void | Returns the current value of mode. If the mode is not set, returns 0. |
| set_mode() | void | uint32 | Sets the value of mode. After calling this, mode() will return value. |
| clear_mode() | void | void | Clears the value of mode. After calling this, mode() will return the empty string/empty bytes. |
| has_gripper() const | bool | void | Returns true if gripper is set. |
| gripper() | const Gripper& | void | Returns the current value of gripper. If gripper is not set, returns a Gripper with none of its fields set (possibly gripper::default_instance()). |
| mutable_gripper() | Gripper * | void | Returns a pointer to the mutable Gripper object that stores the field's value. If the field was not set prior to the call, then the returned Gripper will have none of its fields set (i.e. it will be identical to a newly-allocated Gripper). After calling this, has_gripper() will return true and gripper() will return a reference to the same instance of Gripper. |
| clear_gripper() | void | void | Clears the value of the field. After calling this, has_gripper() will return false and gripper() will return the default value. |
| set_allocated_gripper() | void | Gripper * | Sets the Gripper object to the field and frees the previous field value if it exists. If the Gripper pointer is not NULL, the message takes ownership of the allocated Gripper object and has_ Gripper() will return true. Otherwise, if the gripper is NULL, the behavior is the same as calling clear_gripper(). |
| release_gripper() | Gripper * | void | Releases the ownership of the field and returns the pointer of the Gripper object. After calling this, caller takes the ownership of the allocated Gripper object, has_gripper() will return false, and gripper() will return the default value. |
| duration() | uint32 | void | Returns the current value of duration. If the duration is not set, returns 0. |
| set_duration() | void | uint32 | Sets the value of duration. After calling this, duration() will return value. |
| clear_duration() | void | void | Clears the value of duration. After calling this, duration() will return 0. |
Parent topic: Base (C++)