vidl_v4l2_control_integer Class Reference

#include <vidl_v4l2_control.h>

Inheritance diagram for vidl_v4l2_control_integer:

Inheritance graph
[legend]

List of all members.


Detailed Description

A class for handle a control of type integer.

Definition at line 73 of file vidl_v4l2_control.h.


Public Member Functions

 vidl_v4l2_control_integer (const v4l2_queryctrl &ctr, int f)
int minimum () const
 Minimum value of the control.
int maximum () const
 Maximum value of the control.
int step () const
 Step size.
int default_value () const
 Default value of this control.
void set (int value) const
 Set the value of the control.
void set_100 (int value) const
 Change control.
int get () const
 Get the value of the control.
int get_100 () const
 Get the value of the control.
virtual vcl_string description () const
 A 1-line brief description.
virtual void reset () const
 Reset control.
v4l2_ctrl_type type () const
 Type of control.
vcl_string name () const
 Name of control.
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.

Static Public Member Functions

static vidl_v4l2_controlnew_control (const v4l2_queryctrl &ctr, int f)
 Factory method to create new controls.

Protected Member Functions

void set_value (int v) const
int get_value () const

Protected Attributes

int fd
struct v4l2_queryctrl ctrl_

Constructor & Destructor Documentation

vidl_v4l2_control_integer::vidl_v4l2_control_integer ( const v4l2_queryctrl &  ctr,
int  f 
) [inline]

Definition at line 76 of file vidl_v4l2_control.h.


Member Function Documentation

int vidl_v4l2_control_integer::minimum (  )  const [inline]

Minimum value of the control.

Definition at line 78 of file vidl_v4l2_control.h.

int vidl_v4l2_control_integer::maximum (  )  const [inline]

Maximum value of the control.

Definition at line 80 of file vidl_v4l2_control.h.

int vidl_v4l2_control_integer::step (  )  const [inline]

Step size.

Indicates the increment between values which are actually different on the hardware

Definition at line 83 of file vidl_v4l2_control.h.

int vidl_v4l2_control_integer::default_value (  )  const [inline]

Default value of this control.

Definition at line 85 of file vidl_v4l2_control.h.

void vidl_v4l2_control_integer::set ( int  value  )  const

Set the value of the control.

Parameters:
value to be set in range determined by driver

Definition at line 75 of file vidl_v4l2_control.cxx.

void vidl_v4l2_control_integer::set_100 ( int  value  )  const

Change control.

Parameters:
value to be set in range 0-100

Definition at line 83 of file vidl_v4l2_control.cxx.

int vidl_v4l2_control_integer::get (  )  const [inline]

Get the value of the control.

Returns:
value in range determined by driver

Definition at line 94 of file vidl_v4l2_control.h.

int vidl_v4l2_control_integer::get_100 (  )  const [inline]

Get the value of the control.

Returns:
value in range 0-100

Definition at line 97 of file vidl_v4l2_control.h.

vcl_string vidl_v4l2_control_integer::description (  )  const [virtual]

A 1-line brief description.

Implements vidl_v4l2_control.

Definition at line 91 of file vidl_v4l2_control.cxx.

virtual void vidl_v4l2_control_integer::reset (  )  const [inline, virtual]

Reset control.

Reimplemented from vidl_v4l2_control.

Definition at line 101 of file vidl_v4l2_control.h.

void vidl_v4l2_control::set_value ( int  v  )  const [protected, inherited]

Definition at line 55 of file vidl_v4l2_control.cxx.

int vidl_v4l2_control::get_value (  )  const [protected, inherited]

Definition at line 64 of file vidl_v4l2_control.cxx.

vidl_v4l2_control * vidl_v4l2_control::new_control ( const v4l2_queryctrl &  ctr,
int  f 
) [static, inherited]

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.

v4l2_ctrl_type vidl_v4l2_control::type (  )  const [inline, inherited]

Type of control.

Returns:
type as indicated in v4l2 specification

Definition at line 40 of file vidl_v4l2_control.h.

vcl_string vidl_v4l2_control::name (  )  const [inline, inherited]

Name of control.

Returns:
name the driver assign to the control

Definition at line 43 of file vidl_v4l2_control.h.

int vidl_v4l2_control::id (  )  const [inline, inherited]

Id of control.

Returns:
ID (for example, V4L2_CID_BRIGHTNESS corresponds to brightness)

Definition at line 48 of file vidl_v4l2_control.h.

bool vidl_v4l2_control::read_only (  )  const [inline, inherited]

Control is read only.

Definition at line 50 of file vidl_v4l2_control.h.

bool vidl_v4l2_control::affect_other_controls (  )  const [inline, inherited]

Control can change value of other controls.

Definition at line 59 of file vidl_v4l2_control.h.


Member Data Documentation

int vidl_v4l2_control::fd [protected, inherited]

Definition at line 26 of file vidl_v4l2_control.h.

struct v4l2_queryctrl vidl_v4l2_control::ctrl_ [read, protected, inherited]

Definition at line 27 of file vidl_v4l2_control.h.


The documentation for this class was generated from the following files:

Generated on Sun Nov 22 06:20:26 2009 for core/vidl by  doxygen 1.5.5