Skip to content

Latest commit

 

History

History
36 lines (30 loc) · 6.08 KB

File metadata and controls

36 lines (30 loc) · 6.08 KB

class CustomData

Member values

Member name Data type Description
custom_data_id MessageId MessageId
gripper_custom_data CustomDataUnit  
motor_custom_data CustomDataUnit  

Member functions

Function name Return type Input type Description
has_custom_data_id() const bool void Returns true if custom_data_id is set.
custom_data_id() const MessageId& void Returns the current value of custom_data_id. If custom_data_id is not set, returns a MessageId with none of its fields set (possibly custom_data_id::default_instance()).
mutable_custom_data_id() MessageId * void Returns a pointer to the mutable MessageId object that stores the field's value. If the field was not set prior to the call, then the returned MessageId will have none of its fields set (i.e. it will be identical to a newly-allocated MessageId). After calling this, has_custom_data_id() will return true and custom_data_id() will return a reference to the same instance of MessageId.
clear_custom_data_id() void void Clears the value of the field. After calling this, has_custom_data_id() will return false and custom_data_id() will return the default value.
set_allocated_custom_data_id() void MessageId * Sets the MessageId object to the field and frees the previous field value if it exists. If the MessageId pointer is not NULL, the message takes ownership of the allocated MessageId object and has_ MessageId() will return true. Otherwise, if the custom_data_id is NULL, the behavior is the same as calling clear_custom_data_id().
release_custom_data_id() MessageId * void Releases the ownership of the field and returns the pointer of the MessageId object. After calling this, caller takes the ownership of the allocated MessageId object, has_custom_data_id() will return false, and custom_data_id() will return the default value.
has_gripper_custom_data() const bool void Returns true if gripper_custom_data is set.
gripper_custom_data() const CustomDataUnit& void Returns the current value of gripper_custom_data. If gripper_custom_data is not set, returns a CustomDataUnit with none of its fields set (possibly gripper_custom_data::default_instance()).
mutable_gripper_custom_data() CustomDataUnit * void Returns a pointer to the mutable CustomDataUnit object that stores the field's value. If the field was not set prior to the call, then the returned CustomDataUnit will have none of its fields set (i.e. it will be identical to a newly-allocated CustomDataUnit). After calling this, has_gripper_custom_data() will return true and gripper_custom_data() will return a reference to the same instance of CustomDataUnit.
clear_gripper_custom_data() void void Clears the value of the field. After calling this, has_gripper_custom_data() will return false and gripper_custom_data() will return the default value.
set_allocated_gripper_custom_data() void CustomDataUnit * Sets the CustomDataUnit object to the field and frees the previous field value if it exists. If the CustomDataUnit pointer is not NULL, the message takes ownership of the allocated CustomDataUnit object and has_ CustomDataUnit() will return true. Otherwise, if the gripper_custom_data is NULL, the behavior is the same as calling clear_gripper_custom_data().
release_gripper_custom_data() CustomDataUnit * void Releases the ownership of the field and returns the pointer of the CustomDataUnit object. After calling this, caller takes the ownership of the allocated CustomDataUnit object, has_gripper_custom_data() will return false, and gripper_custom_data() will return the default value.
motor_custom_data_size() const int void Returns the number of elements currently in the field.
motor_custom_data() const const CustomDataUnit int index Returns the element at the given zero-based index. Calling this method with index outside of [0, motor_custom_data_size()) yields undefined behavior.
mutable_motor_custom_data() CustomDataUnit* int index Returns a pointer to the mutable CustomDataUnit object that stores the value of the element at the given zero-based index. Calling this method with index outside of [0, motor_custom_data_size()) yields undefined behavior.
add_motor_custom_data() CustomDataUnit* void Adds a new element and returns a pointer to it. The returned CustomDataUnit is mutable and will have none of its fields set (i.e. it will be identical to a newly-allocated CustomDataUnit).
clear_motor_custom_data() void void Removes all elements from the field. After calling this, motor_custom_data_size() will return zero.
motor_custom_data() const const RepeatedPtrField< CustomDataUnit>& void Returns the underlying RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.
mutable_motor_custom_data() RepeatedPtrField< CustomDataUnit>* void Returns a pointer to the underlying mutable RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.

Parent topic: GripperCyclic (C++)