Member values
| Member name | Data type | Description |
|---|---|---|
| reference_frame | uint32 | The reference frame used for the wrench command |
| mode | uint32 | Mode in which the command is executed |
| wrench | Wrench | Wrench value |
| duration | uint32 | Duration constraint. If not 0, allows to set a limit (in milliseconds) to the WrenchCommand |
Member functions
| Function name | Return type | Input type | Description |
|---|---|---|---|
| reference_frame() const | uint32 | void | Returns the current value of reference_frame. If the reference_frame is not set, returns 0. |
| set_reference_frame() | void | uint32 | Sets the value of reference_frame. After calling this, reference_frame() will return value. |
| clear_reference_frame() | void | void | Clears the value of reference_frame. After calling this, reference_frame() will return the empty string/empty bytes. |
| 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_wrench() const | bool | void | Returns true if wrench is set. |
| wrench() | const Wrench& | void | Returns the current value of wrench. If wrench is not set, returns a Wrench with none of its fields set (possibly wrench::default_instance()). |
| mutable_wrench() | Wrench * | void | Returns a pointer to the mutable Wrench object that stores the field's value. If the field was not set prior to the call, then the returned Wrench will have none of its fields set (i.e. it will be identical to a newly-allocated Wrench). After calling this, has_wrench() will return true and wrench() will return a reference to the same instance of Wrench. |
| clear_wrench() | void | void | Clears the value of the field. After calling this, has_wrench() will return false and wrench() will return the default value. |
| set_allocated_wrench() | void | Wrench * | Sets the Wrench object to the field and frees the previous field value if it exists. If the Wrench pointer is not NULL, the message takes ownership of the allocated Wrench object and has_ Wrench() will return true. Otherwise, if the wrench is NULL, the behavior is the same as calling clear_wrench(). |
| release_wrench() | Wrench * | void | Releases the ownership of the field and returns the pointer of the Wrench object. After calling this, caller takes the ownership of the allocated Wrench object, has_wrench() will return false, and wrench() 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++)