A base class for handle a control. More...
#include <vidl_v4l2_control.h>
Public Member Functions | |
| virtual | ~vidl_v4l2_control () |
| v4l2_ctrl_type | type () const |
| Type of control. | |
| vcl_string | name () const |
| Name of control. | |
| virtual vcl_string | description () const =0 |
| A 1-line brief description. | |
| int | id () const |
| Id of control. | |
| bool | read_only () const |
| Control is read only. | |
| bool | affect_other_controls () const |
| Control can change value of other controls. | |
| virtual void | reset () const |
| Reset control. | |
Static Public Member Functions | |
| static vidl_v4l2_control * | new_control (const v4l2_queryctrl &ctr, int f) |
| Factory method to create new controls. | |
Protected Member Functions | |
| vidl_v4l2_control (const v4l2_queryctrl &ctr, int f) | |
| void | set_value (int v) const |
| int | get_value () const |
Protected Attributes | |
| int | fd |
| struct v4l2_queryctrl | ctrl_ |
Detailed Description
A base class for handle a control.
Definition at line 24 of file vidl_v4l2_control.h.
Constructor & Destructor Documentation
| vidl_v4l2_control::vidl_v4l2_control | ( | const v4l2_queryctrl & | ctr, |
| int | f | ||
| ) | [inline, protected] |
Definition at line 29 of file vidl_v4l2_control.h.
| virtual vidl_v4l2_control::~vidl_v4l2_control | ( | ) | [inline, virtual] |
Definition at line 33 of file vidl_v4l2_control.h.
Member Function Documentation
| bool vidl_v4l2_control::affect_other_controls | ( | ) | const [inline] |
Control can change value of other controls.
Definition at line 60 of file vidl_v4l2_control.h.
| virtual vcl_string vidl_v4l2_control::description | ( | ) | const [pure virtual] |
A 1-line brief description.
Implemented in vidl_v4l2_control_button, vidl_v4l2_control_boolean, vidl_v4l2_control_menu, and vidl_v4l2_control_integer.
| int vidl_v4l2_control::get_value | ( | ) | const [protected] |
Definition at line 64 of file vidl_v4l2_control.cxx.
| int vidl_v4l2_control::id | ( | ) | const [inline] |
Id of control.
- Returns:
- ID (for example, V4L2_CID_BRIGHTNESS corresponds to brightness)
Definition at line 49 of file vidl_v4l2_control.h.
| vcl_string vidl_v4l2_control::name | ( | ) | const [inline] |
Name of control.
- Returns:
- name the driver assign to the control
Definition at line 44 of file vidl_v4l2_control.h.
| vidl_v4l2_control * vidl_v4l2_control::new_control | ( | const v4l2_queryctrl & | ctr, |
| int | f | ||
| ) | [static] |
Factory method to create new controls.
- Parameters:
-
ctr details from VIDIOC_QUERYCTRL f associated file descriptor
- Returns:
- pointer to base class of new control
Definition at line 20 of file vidl_v4l2_control.cxx.
| bool vidl_v4l2_control::read_only | ( | ) | const [inline] |
Control is read only.
Definition at line 51 of file vidl_v4l2_control.h.
| virtual void vidl_v4l2_control::reset | ( | ) | const [inline, virtual] |
Reset control.
- Note:
- no-op fot button controls
Reimplemented in vidl_v4l2_control_boolean, vidl_v4l2_control_menu, and vidl_v4l2_control_integer.
Definition at line 70 of file vidl_v4l2_control.h.
| void vidl_v4l2_control::set_value | ( | int | v | ) | const [protected] |
Definition at line 55 of file vidl_v4l2_control.cxx.
| v4l2_ctrl_type vidl_v4l2_control::type | ( | ) | const [inline] |
Type of control.
- Returns:
- type as indicated in v4l2 specification
Definition at line 41 of file vidl_v4l2_control.h.
Member Data Documentation
struct v4l2_queryctrl vidl_v4l2_control::ctrl_ [protected] |
Definition at line 28 of file vidl_v4l2_control.h.
int vidl_v4l2_control::fd [protected] |
Definition at line 27 of file vidl_v4l2_control.h.
The documentation for this class was generated from the following files:
- core/vidl/vidl_v4l2_control.h
- core/vidl/vidl_v4l2_control.cxx
