class CustomData

Member values

Member name	Data type	Description
custom_data_id	MessageId	MessageId
custom_data_0	uint32	Custom data word 0
custom_data_1	uint32	Custom data word 1
custom_data_2	uint32	Custom data word 2
custom_data_3	uint32	Custom data word 3
custom_data_4	uint32	Custom data word 4
custom_data_5	uint32	Custom data word 5
custom_data_6	uint32	Custom data word 6
custom_data_7	uint32	Custom data word 7
custom_data_8	uint32	Custom data word 8
custom_data_9	uint32	Custom data word 9
custom_data_10	uint32	Custom data word 10
custom_data_11	uint32	Custom data word 11
custom_data_12	uint32	Custom data word 12
custom_data_13	uint32	Custom data word 13
custom_data_14	uint32	Custom data word 14
custom_data_15	uint32	Custom data word 15
gripper_custom_data	oneof:tool_customData CustomData

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.
custom_data_0()	uint32	void	Returns the current value of custom_data_0. If the custom_data_0 is not set, returns 0.
set_custom_data_0()	void	uint32	Sets the value of custom_data_0. After calling this, custom_data_0() will return value.
clear_custom_data_0()	void	void	Clears the value of custom_data_0. After calling this, custom_data_0() will return 0.
custom_data_1()	uint32	void	Returns the current value of custom_data_1. If the custom_data_1 is not set, returns 0.
set_custom_data_1()	void	uint32	Sets the value of custom_data_1. After calling this, custom_data_1() will return value.
clear_custom_data_1()	void	void	Clears the value of custom_data_1. After calling this, custom_data_1() will return 0.
custom_data_2()	uint32	void	Returns the current value of custom_data_2. If the custom_data_2 is not set, returns 0.
set_custom_data_2()	void	uint32	Sets the value of custom_data_2. After calling this, custom_data_2() will return value.
clear_custom_data_2()	void	void	Clears the value of custom_data_2. After calling this, custom_data_2() will return 0.
custom_data_3()	uint32	void	Returns the current value of custom_data_3. If the custom_data_3 is not set, returns 0.
set_custom_data_3()	void	uint32	Sets the value of custom_data_3. After calling this, custom_data_3() will return value.
clear_custom_data_3()	void	void	Clears the value of custom_data_3. After calling this, custom_data_3() will return 0.
custom_data_4()	uint32	void	Returns the current value of custom_data_4. If the custom_data_4 is not set, returns 0.
set_custom_data_4()	void	uint32	Sets the value of custom_data_4. After calling this, custom_data_4() will return value.
clear_custom_data_4()	void	void	Clears the value of custom_data_4. After calling this, custom_data_4() will return 0.
custom_data_5()	uint32	void	Returns the current value of custom_data_5. If the custom_data_5 is not set, returns 0.
set_custom_data_5()	void	uint32	Sets the value of custom_data_5. After calling this, custom_data_5() will return value.
clear_custom_data_5()	void	void	Clears the value of custom_data_5. After calling this, custom_data_5() will return 0.
custom_data_6()	uint32	void	Returns the current value of custom_data_6. If the custom_data_6 is not set, returns 0.
set_custom_data_6()	void	uint32	Sets the value of custom_data_6. After calling this, custom_data_6() will return value.
clear_custom_data_6()	void	void	Clears the value of custom_data_6. After calling this, custom_data_6() will return 0.
custom_data_7()	uint32	void	Returns the current value of custom_data_7. If the custom_data_7 is not set, returns 0.
set_custom_data_7()	void	uint32	Sets the value of custom_data_7. After calling this, custom_data_7() will return value.
clear_custom_data_7()	void	void	Clears the value of custom_data_7. After calling this, custom_data_7() will return 0.
custom_data_8()	uint32	void	Returns the current value of custom_data_8. If the custom_data_8 is not set, returns 0.
set_custom_data_8()	void	uint32	Sets the value of custom_data_8. After calling this, custom_data_8() will return value.
clear_custom_data_8()	void	void	Clears the value of custom_data_8. After calling this, custom_data_8() will return 0.
custom_data_9()	uint32	void	Returns the current value of custom_data_9. If the custom_data_9 is not set, returns 0.
set_custom_data_9()	void	uint32	Sets the value of custom_data_9. After calling this, custom_data_9() will return value.
clear_custom_data_9()	void	void	Clears the value of custom_data_9. After calling this, custom_data_9() will return 0.
custom_data_10()	uint32	void	Returns the current value of custom_data_10. If the custom_data_10 is not set, returns 0.
set_custom_data_10()	void	uint32	Sets the value of custom_data_10. After calling this, custom_data_10() will return value.
clear_custom_data_10()	void	void	Clears the value of custom_data_10. After calling this, custom_data_10() will return 0.
custom_data_11()	uint32	void	Returns the current value of custom_data_11. If the custom_data_11 is not set, returns 0.
set_custom_data_11()	void	uint32	Sets the value of custom_data_11. After calling this, custom_data_11() will return value.
clear_custom_data_11()	void	void	Clears the value of custom_data_11. After calling this, custom_data_11() will return 0.
custom_data_12()	uint32	void	Returns the current value of custom_data_12. If the custom_data_12 is not set, returns 0.
set_custom_data_12()	void	uint32	Sets the value of custom_data_12. After calling this, custom_data_12() will return value.
clear_custom_data_12()	void	void	Clears the value of custom_data_12. After calling this, custom_data_12() will return 0.
custom_data_13()	uint32	void	Returns the current value of custom_data_13. If the custom_data_13 is not set, returns 0.
set_custom_data_13()	void	uint32	Sets the value of custom_data_13. After calling this, custom_data_13() will return value.
clear_custom_data_13()	void	void	Clears the value of custom_data_13. After calling this, custom_data_13() will return 0.
custom_data_14()	uint32	void	Returns the current value of custom_data_14. If the custom_data_14 is not set, returns 0.
set_custom_data_14()	void	uint32	Sets the value of custom_data_14. After calling this, custom_data_14() will return value.
clear_custom_data_14()	void	void	Clears the value of custom_data_14. After calling this, custom_data_14() will return 0.
custom_data_15()	uint32	void	Returns the current value of custom_data_15. If the custom_data_15 is not set, returns 0.
set_custom_data_15()	void	uint32	Sets the value of custom_data_15. After calling this, custom_data_15() will return value.
clear_custom_data_15()	void	void	Clears the value of custom_data_15. After calling this, custom_data_15() will return 0.
has_gripper_custom_data() const	void	void	Returns the current value of the field if oneof case is kGripper_custom_data. Otherwise, returns oneof:tool_customData CustomData::default_instance()
gripper_custom_data() const	const oneof:tool_customData CustomData&	void	Returns the current value of the field if oneof case is kGripper_custom_data
mutable_gripper_custom_data()	oneof:tool_customData CustomData*	void	If any other oneof field in the same oneof is set, calls clear_tool_customData(). Sets the oneof case to kGripper_custom_data and returns a pointer to the mutable oneof:tool_customData CustomData object that stores the field's value. If the oneof case was not kGripper_custom_data prior to the call, then the returned oneof:tool_customData CustomData will have none of its fields set (i.e. it will be identical to a newly-allocated oneof:tool_customData CustomData). After calling this, has_gripper_custom_data() will return true, gripper_custom_data() will return a reference to the same instance of oneof:tool_customData CustomData and tool_customData_case() will return kGripper_custom_data
clear_gripper_custom_data()	void	void	Nothing will be changed if the oneof case is not kGripper_custom_data. If the oneof case equals kGripper_custom_data, frees the field and clears the oneof case. has_gripper_custom_data() will return false, gripper_custom_data() will return the default value and tool_customData_case() will return TOOL_CUSTOMDATA_NOT_SET.
set_allocated_gripper_custom_data()	void	oneof:tool_customData CustomData*	Calls clear_tool_customData(). If the oneof:tool_customData CustomData pointer is not NULL: Sets the oneof:tool_customData CustomData object to the field and sets the oneof case to kGripper_custom_data. The message takes ownership of the allocated oneof:tool_customData CustomData object, has_gripper_custom_data() will return true and tool_customData_case() will return kGripper_custom_data. If the pointer is NULL, has_gripper_custom_data() will return false and tool_customData_case() will return TOOL_CUSTOMDATA_NOT_SET. (The behavior is like calling clear_tool_customData())
release_gripper_custom_data()	oneof:tool_customData CustomData*	void	Returns NULL if oneof case is not kGripper_custom_data. If the oneof case is kGripper_custom_data, clears the oneof case, releases the ownership of the field and returns the pointer of the tool_customData object. After calling this, caller takes the ownership of the allocated tool_customData object, has_gripper_custom_data() will return false, gripper_custom_data() will return the default value and tool_customData_case() will return TOOL_CUSTOMDATA_NOT_SET.

Parent topic: InterconnectCyclic (C++)