class SensorFocusAction

August 13, 2019 · View on GitHub

Member values

Member name	Data type	Description
sensor	uint32	The sensor on which to perform the focus action
focus_action	uint32	The focus action to perform on the sensor
focus_point	oneof:action_parameters FocusPoint	The X-Y point on which to focus
manual_focus	oneof:action_parameters ManualFocus	The manual focus abstract value

Member functions

Function name	Return type	Input type	Description
sensor() const	uint32	void	Returns the current value of sensor. If the sensor is not set, returns 0.
set_sensor()	void	uint32	Sets the value of sensor. After calling this, sensor() will return value.
clear_sensor()	void	void	Clears the value of sensor. After calling this, sensor() will return the empty string/empty bytes.
focus_action() const	uint32	void	Returns the current value of focus_action. If the focus_action is not set, returns 0.
set_focus_action()	void	uint32	Sets the value of focus_action. After calling this, focus_action() will return value.
clear_focus_action()	void	void	Clears the value of focus_action. After calling this, focus_action() will return the empty string/empty bytes.
has_focus_point() const	void	void	Returns the current value of the field if oneof case is kFocus_point. Otherwise, returns oneof:action_parameters FocusPoint::default_instance()
focus_point() const	const oneof:action_parameters FocusPoint&	void	Returns the current value of the field if oneof case is kFocus_point
mutable_focus_point()	oneof:action_parameters FocusPoint*	void	If any other oneof field in the same oneof is set, calls clear_action_parameters(). Sets the oneof case to kFocus_point and returns a pointer to the mutable oneof:action_parameters FocusPoint object that stores the field's value. If the oneof case was not kFocus_point prior to the call, then the returned oneof:action_parameters FocusPoint will have none of its fields set (i.e. it will be identical to a newly-allocated oneof:action_parameters FocusPoint). After calling this, has_focus_point() will return true, focus_point() will return a reference to the same instance of oneof:action_parameters FocusPoint and action_parameters_case() will return kFocus_point
clear_focus_point()	void	void	Nothing will be changed if the oneof case is not kFocus_point. If the oneof case equals kFocus_point, frees the field and clears the oneof case. has_focus_point() will return false, focus_point() will return the default value and action_parameters_case() will return ACTION_PARAMETERS_NOT_SET.
set_allocated_focus_point()	void	oneof:action_parameters FocusPoint*	Calls clear_action_parameters(). If the oneof:action_parameters FocusPoint pointer is not NULL: Sets the oneof:action_parameters FocusPoint object to the field and sets the oneof case to kFocus_point. The message takes ownership of the allocated oneof:action_parameters FocusPoint object, has_focus_point() will return true and action_parameters_case() will return kFocus_point. If the pointer is NULL, has_focus_point() will return false and action_parameters_case() will return ACTION_PARAMETERS_NOT_SET. (The behavior is like calling clear_action_parameters())
release_focus_point()	oneof:action_parameters FocusPoint*	void	Returns NULL if oneof case is not kFocus_point. If the oneof case is kFocus_point, clears the oneof case, releases the ownership of the field and returns the pointer of the action_parameters object. After calling this, caller takes the ownership of the allocated action_parameters object, has_focus_point() will return false, focus_point() will return the default value and action_parameters_case() will return ACTION_PARAMETERS_NOT_SET.
has_manual_focus() const	void	void	Returns the current value of the field if oneof case is kManual_focus. Otherwise, returns oneof:action_parameters ManualFocus::default_instance()
manual_focus() const	const oneof:action_parameters ManualFocus&	void	Returns the current value of the field if oneof case is kManual_focus
mutable_manual_focus()	oneof:action_parameters ManualFocus*	void	If any other oneof field in the same oneof is set, calls clear_action_parameters(). Sets the oneof case to kManual_focus and returns a pointer to the mutable oneof:action_parameters ManualFocus object that stores the field's value. If the oneof case was not kManual_focus prior to the call, then the returned oneof:action_parameters ManualFocus will have none of its fields set (i.e. it will be identical to a newly-allocated oneof:action_parameters ManualFocus). After calling this, has_manual_focus() will return true, manual_focus() will return a reference to the same instance of oneof:action_parameters ManualFocus and action_parameters_case() will return kManual_focus
clear_manual_focus()	void	void	Nothing will be changed if the oneof case is not kManual_focus. If the oneof case equals kManual_focus, frees the field and clears the oneof case. has_manual_focus() will return false, manual_focus() will return the default value and action_parameters_case() will return ACTION_PARAMETERS_NOT_SET.
set_allocated_manual_focus()	void	oneof:action_parameters ManualFocus*	Calls clear_action_parameters(). If the oneof:action_parameters ManualFocus pointer is not NULL: Sets the oneof:action_parameters ManualFocus object to the field and sets the oneof case to kManual_focus. The message takes ownership of the allocated oneof:action_parameters ManualFocus object, has_manual_focus() will return true and action_parameters_case() will return kManual_focus. If the pointer is NULL, has_manual_focus() will return false and action_parameters_case() will return ACTION_PARAMETERS_NOT_SET. (The behavior is like calling clear_action_parameters())
release_manual_focus()	oneof:action_parameters ManualFocus*	void	Returns NULL if oneof case is not kManual_focus. If the oneof case is kManual_focus, clears the oneof case, releases the ownership of the field and returns the pointer of the action_parameters object. After calling this, caller takes the ownership of the allocated action_parameters object, has_manual_focus() will return false, manual_focus() will return the default value and action_parameters_case() will return ACTION_PARAMETERS_NOT_SET.

Parent topic: VisionConfig (C++)